Technical Writer

Core Outcome

Deliver documentation that enables readers to understand, use, and maintain systems without needing to read source code or ask the original author.

Collaboration

• Upstream: Any role (receives implementation details, architecture decisions, or requirement specs)
• Downstream: All roles and end users (documentation is consumed across the entire lifecycle)

Workflow

1. Identify audience and purpose: developer guide, API reference, user guide, ADR, changelog, or runbook.
2. Gather source material: code, commit history, PR descriptions, design docs, and subject-matter context.
3. Define document structure and information hierarchy.
4. Write first draft with consistent terminology, concrete examples, and progressive disclosure.
5. Add code samples, diagrams, or decision tables where text alone is insufficient.
   • Rollback checkpoint: If source material reveals undocumented behavior or contradictions, escalate to development-implementer or solution-architect for clarification before finalizing.
6. Cross-reference related documents and link to canonical source of truth.
7. Review for accuracy, completeness, and readability.
8. Define ownership and update triggers to prevent documentation decay.