THE GUIDE COLLECTION
Learn the craft. Build the workflow.
Start with foundations, then put each idea to work in your own documentation.
Foundations
Start with the reader’s task
Turn a feature description into documentation someone can act on.
Read guide Foundations / ExplanationChoose the right document type
Separate learning, task completion, lookup, and understanding.
Read guide Foundations / How-toBuild a practical technical-writing portfolio
Show research, writing, and testing through a small set of useful samples.
Read guideWriting practice
Write a procedure people can follow
Use prerequisites, numbered actions, and visible success checks.
Read guide Writing practice / How-toEdit for clarity and consistency
Replace vague wording with specific actors, actions, and terms.
Read guide Writing practice / How-toWrite troubleshooting that leads somewhere
Connect an observable symptom to checks, fixes, and escalation.
Read guide Writing practice / TemplateWrite release notes around user impact
Explain what changed, who is affected, and what to do next.
Read guide Writing practice / TemplateReusable templates for everyday documentation
Start a how-to, reference entry, or troubleshooting article with useful fields.
Read guideAPI documentation
Document an API from first request to reference
Explain setup, requests, responses, and failure recovery together.
Read guide API documentation / ExplanationUse OpenAPI without losing the user journey
Let a contract supply reference structure while guides explain tasks.
Read guidePublishing
Run a small docs-as-code workflow
Move a documentation change through version control, review, and publication.
Read guide Publishing / ReferenceChoose documentation tools by the work
Compare authoring, generation, hosting, and quality tools by role.
Read guideQuality
Make documentation easier to access
Check structure, link labels, images, and instructions.
Read guide Quality / How-toReview documentation before release
Combine technical checks, editorial review, and a realistic task test.
Read guide Quality / How-toKeep documentation useful after publication
Use ownership, feedback, and version context to keep pages current.
Read guide Quality / How-toUse AI drafts with a verification plan
Give drafting assistance a bounded task and verify the result.
Read guide