Services

I offer the following products and services.

Technical Editing

Editing exiting guides or OpenAPI specs.

My editing process includes:

• Editing for clarity and conciseness
• Checking code samples
• Reviewing for consistent terminology
• And more!

I have systems in place and an established toolchain that make the process speed along.

Technical Writing

Create new guides or OpenAPI (OAS) specs. I will create your OAS spec from scratch and/or write usage guides. During the writing process I edit my own work and validate all code samples are accurate.

Style Guide

A style guide to maintain consistency in your guides and OpenAPI (OAS) specs.

I will review your existing documentation and create a style guide based on the standards I see. (Delivered in the format of your choice.) A style guide is key in maintaining consistently great docs. The best time to create a style guide is after you have an existing OAS spec and multiple guides. Without a style guide it is common to have a set of standards that are generally followed, but regularly deviated from. (For example, irregular title case, periods at the end of OAS descriptions, etc.)

Documentation Audit

A complete audit of your existing documentation. Includes recommendations for improvement (menu navigation, documentation format, etc.), FAQs, and a list of any mistakes found in the docs or code samples.

Docs-as-Code System

This is my most comprehensive offering. The deliverable is a full docs-as-code system set up to work with the docs tool of your choice*.

Note: The tool must support CI/CD.

Pricing

For custom pricing options, please contact me directly.