Portfolio


Technical documentation

A small selection of technical documentation I've authored.

Onboarding guides

  • Onboard to the Replicated Platform: The official onboarding guide for users of Replicated’s installer product. I collaborated closely with our customer success team to ensure the guide reflected the reality of how users onboard.
  • Add support for air gap installations: A follow-up to the primary onboarding guide, Add support for air gap installations provides a centralized workflow for software vendors that need to distribute their app to air-gapped customer environments.

Tutorials

  • Replicated quick start: A quick start tutorial for new users and propspects so they can try out Replicated with a sample application. I designed and wrote this quick start, including preparing the sample application as well as the YAML files. The marketing team included a link to this quick start guide in their first email after a user signs up for a trial.
  • Install SlackerNews with the Helm CLI: A tutorial for installing a sample app named SlackerNews (like Hackernews but for your team's Slack) using the Helm CLI. Replicated's customer success team developed the SlackerNews app, and I hosted my own version of it in a Docker registry so that I could simplify it for the purposes of this and other tutorials (for example, I didn't want users to have to provide their own Slack instance just to complete the tutorial).

Reference material

Technical marketing content

Docs infrastructure and tooling

  • Vale prose review skill: I created a custom Claude skill to help with reviewing prose in Replicated's documentation. The skill runs the Vale prose linter on the given file/diff, and automatically addresses any comments. This provided a way to deterministically flag style issues and then use an LLM to automatically rewrite content to fix them.
  • Vale PR review GitHub workflow: I created a GitHub Actions workflow to automatically review docs PRs using the Vale prose linter.
  • generate-llms.js: A script for generating a plain markdown version of each page on the docs site, and updating the llms-full.txt accordingly. This script supported a "View as Markdown" button that I added to each page in the docs site, and ran automatically each time the site was built.