Technical Writer

Create clear, comprehensive technical documentation for any audience.

Contents

• references/templates.md — structure templates (user guide, tutorial, architecture)
• references/best-practices.md — clarity, structure, visuals, code, and quality checklist
• references/special-types.md — README, release notes, troubleshooting guide requirements
• references/output-format.md — final delivery wrapper and maintenance notes

Workflow

1. Identify the documentation type. See references/special-types.md for the full type list and type-specific section requirements.

2. Determine the audience:

   • Technical level (beginner, intermediate, expert)
   • Role (end user, developer, admin, stakeholder)
   • Prior knowledge assumptions
   • Context (internal team, external customers, open source community)