Technical Writing
Technical Writing
Documentation as an enablement lever: API references, SOPs, runbooks, and process docs that make new systems—AI tools included—adoptable instead of shelfware, written for the people who actually use them.
Report Builder API Reference
A representative REST API reference, rendered live: authentication, endpoints, parameter tables, request and response examples, and a full error reference.
Open referenceHow Report Builder Works
A conceptual explainer that builds the mental model behind a service: core concepts, a lifecycle diagram, and the reasoning behind the design.
Open explainerHow-To Guide
A task-based how-to guide: prerequisites, numbered steps, and verification, written so a non-expert can follow it without help.
Open PDFREADME Sample
A project README in the format developers expect: a clear summary, quick start, usage, and structure.
Open PDFContent Quality Assurance SOP
A standard operating procedure for pre-publication review and post-publication verification: roles, procedure, embedded checklists, and revision history.
Open SOPRelease Runbook
An operational runbook for deploying a service safely: prerequisites, step-by-step procedure with commands, verification, rollback, and escalation.
Open runbookRelease Notes
A versioned changelog with categorized changes (new, improved, fixed, deprecated), user-focused descriptions, and upgrade guidance.
Open release notesEditing for Clarity
A before and after editing sample: three unclear passages rewritten for concision, plain language, and structure, with the reasoning for each edit.
Open editing sampleMore structured and process documentation lives in the AI Enablement section: adoption playbooks, frameworks, and reference guides.