Writing Samples
During my time as a technical writer, I’ve written a lot of documentation—but don’t just take my word for it! Here are some examples of the different types of docs I’ve worked on over the years.
User guides #
Everything from step-by-step installation guides to big-picture conceptual explainers. (These are based on real docs that I’ve published, but all company and product names have been anonymized.)
- 📝 Integration Options
- A product overview that compares the two available integration options for ProductABC.
- 📝 Tag Types & Environments
- A technical reference that compares ProductXYZ’s various detection tags and the environments they run in.
- 📝 Closing the Loop
- A conceptual guide that describes how (and why) to use ProductABC and ProductXYZ together.
- 📝 IVT Taxonomy
- A glossary that defines the different categories of invalid traffic (IVT) detected by CompanyName.
- 📝 Clusters
- A product overview with information about the server clusters that CompanyName sets up on behalf of each ProductABC user.
- 📝 Set Up Dashboard Alerts
- A conceptual guide that describes how to set up email alerts through the CompanyName Dashboard.
- 📝 Create and Adjust Custom Views
- A conceptual guide that describes how to create custom data visualizations in the CompanyName Dashboard.
- 📝 Dashboard SSO
- An integration walkthrough that explains how to configure Okta single sign-on access for the CompanyName Dashboard.
API docs #
I wish I could share the actual APIs and SDKs I’ve worked on, but it’s hard to do that without divulging sensitive product info… so, for the sake of this sample collection, I opted to design my own mock API and document that instead.
- 💻 Pigeon Protocol API
- An API reference for the fictitious Pigeon Protocol service.
Content marketing #
Not your typical tech writer fare, but I reported to Marketing at one point and wrote enough marketing-led docs to warrant including these here. (Like the user guides, they’re all real samples—minus any identifying details.)
- 📚 User Risk Factors
- A short blog post that explains some of the most common user risk factors flagged by CompanyName’s fraud detection algorithm.
- 📚 In Ecommerce, Trust is Key
- A statistics-driven report about ecommerce consumer trust.
- 📚 Best Practices For Order Rules
- A short blog post that helps users get the most out of ProductName’s Order Rules feature.
Miscellaneous #
Other docs-related goodies.
- 💾 AK’s Style Guide Template
- A Jekyll-based framework for building style guides that use single-sourced rulesets across multiple audiences.