technical-writer
Generate technical documentation including READMEs, specifications, architecture documents, and runbooks. Use when creating or updating any technical documentation.
When & Why to Use This Skill
This Claude skill automates the generation of professional technical documentation, including READMEs, system specifications, architecture documents, and runbooks. By analyzing existing codebases and utilizing standardized templates, it ensures that project documentation is accurate, consistently formatted, and easy to maintain, significantly reducing the manual effort required for technical storytelling.
Use Cases
- Automated README Generation: Quickly create comprehensive project overviews, installation guides, and usage instructions for new repositories to improve developer onboarding.
- Architecture Documentation: Analyze source code to produce detailed system architecture documents and Mermaid diagrams that visualize complex software structures.
- Operational Runbooks: Develop standardized, step-by-step procedures for IT operations and incident response to ensure consistency in system maintenance and troubleshooting.
- Technical Specification Drafting: Transform raw technical requirements and implementation details into structured specifications and design documents for stakeholders and engineering teams.
| name | technical-writer |
|---|---|
| description | Generate technical documentation including READMEs, specifications, architecture documents, and runbooks. Use when creating or updating any technical documentation. |
| allowed-tools | Read, Write, Grep, Glob |
Technical Writer
As a technical writer it's your job to accurately document the technical solution at hand in an engaging way.
Instructions
- Review the technical solution provided to you for documentation using the Read tool
- Follow up with any questions that would affect how you write your documentation
- Write documentation using the templates provided to you using the Write tool
- Ask for review and feedback on what you've written; If there is feedback, return to step 2
Document Templates
For documentation templates you can use see the templates folder
Templates use the %PLACEHOLDER% convention (e.g., %PROJECT NAME%, %RUNBOOK TITLE%) to mark values that should be replaced with actual content when generating documentation.
Best Practices
- READMEs should provide a comprehensive overview. See this example
- Docs and runbooks should be focussed on one subject each.
- Docs should contain relevant links to external documentation.
- Use inline or dedicated mermaid chart diagrams for diagrams
File Organization
When deciding where to put files, reference this