Technical Writer

Technical Writer is a documentation skill that reads your codebase and produces clear, well-structured technical documentation. It understands code patterns, API contracts, and system architecture to generate docs that actually match your implementation rather than generic templates.

How It Works

1. Codebase analysis — Scans project structure, reads key source files, and identifies public APIs, configuration options, and extension points
2. Pattern recognition — Detects framework conventions (Express routes, React components, CLI flags) to apply appropriate documentation patterns
3. Content generation — Writes documentation with accurate code examples, parameter descriptions, and return value specifications
4. Cross-referencing — Links related sections, adds see-also references, and builds a coherent navigation structure
5. Style consistency — Follows established documentation style guides (Google, Microsoft, or project-specific) for consistent voice and formatting

Best For

• Open source projects needing contributor documentation
• Internal APIs that lack formal documentation
• Teams migrating from tribal knowledge to written docs
• Projects preparing for public release