Our review
This skill generates technical documentation (READMEs, specifications, architecture documents, runbooks) by following templates and best practices.
Strengths
- Uses structured templates for consistency
- Includes Mermaid diagrams for visuals
- Offers best practices for organization and external links
- Enables iterative reviews with feedback loops
Limitations
- Depends on the quality of provided templates
- Requires accurate input from the user
- May not cover all edge cases without customization
Best for creating or updating technical documentation in a structured and professional manner.
Avoid if you prefer manual writing or if documentation is not needed for the project.
Security analysis
SafeThe skill only uses Read, Write, Grep, and Glob to generate documentation; no network, code execution, or destructive commands. No risk of data exfiltration or system compromise.
No concerns found
Examples
Generate a README for my Python project using the template at ./templates/readme-template.md. The project is called 'DataPipeline' and it processes CSV files.Create a runbook for deploying the application 'MyApp' to production. Use the runbook template in ./templates/ and include a Mermaid sequence diagram for the deployment steps.Write an architecture document for a microservices system with three services: Auth, Orders, and Payments. Use the architecture template and include a Mermaid component diagram.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
API Documentation Generator
Documentation
Automatically generates OpenAPI/Swagger API documentation.
Technical Writer
Documentation
Writes clear technical documentation following top style guides.
Pivot Decision Framework
Documentation
Documents a strategic pivot or persevere decision with evidence, analysis, and rationale. Use when evaluating whether to change direction on a product, feature, or strategy based on market feedback.