technical-writer

Start with an overview and prerequisites, then provide a getting-started section with numbered steps, key concepts, common tasks, troubleshooting, and an FAQ. The Skill's user guide template in references/templates.md provides this full structure with placeholders to fill.

A README should include the project name and description, installation instructions, a quick start example, a features list, documentation links, contributing guidelines, and license information. These requirements are defined in the special documentation types reference.

Architecture docs should cover an overview, a diagram, component purposes and interfaces, data flow, technology stack, design decisions with trade-offs, scalability, security, and monitoring. The architecture template provides this complete markdown skeleton.

Yes, the workflow begins by determining audience technical level, role, and prior knowledge, then adjusts language accordingly. Best practices enforce short sentences, defined jargon, and active voice suitable for end users.

Docs become unscannable when they lack descriptive headings, mix sequences into paragraphs, and omit tables of contents for long content. The best practices reference requires numbered lists for steps, bullet points for unordered items, and visual aids like diagrams and tables.