Our review
Generates technical documentation such as READMEs, specifications, architecture documents, and runbooks from technical solutions.
Strengths
- Uses structured templates for consistent documentation
- Integrates Mermaid diagrams for visual explanations
- Allows iterative review and improvement through feedback
- Organizes files according to clear conventions
Limitations
- Requires the user to provide a detailed technical solution as input
- Templates must exist in the ./templates/ folder
- May need manual adjustments for very specific formats
Best for creating or updating any technical documentation, including READMEs, specs, architecture, or runbooks.
Avoid for creative or marketing documentation that does not follow standard technical structure.
Security analysis
SafeThe skill uses only Read, Write, Grep, Glob — standard file operations. There are no network calls, code execution, or destructive commands, and no obfuscated payloads. It poses no meaningful security risk.
No concerns found
Examples
Generate a comprehensive README for this Python project using the readme-template.md. The project is a CLI tool for file conversion.Create a runbook for deploying the microservices application using the runbook template. Include a Mermaid flowchart of the deployment process.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.