Our review
Generates comprehensive technical documentation including READMEs, specifications, architecture documents, and runbooks.
Strengths
- Leverages predefined document templates for consistency.
- Supports Mermaid diagrams for clear visual representation.
- Iterative process with review and feedback loops for refinement.
Limitations
- Requires templates to be available in the repository.
- May produce overly generic content if technical context is insufficient.
- Does not replace human review for domain-specific nuances.
Use this skill when you need to create or update structured technical documentation for a software project.
Avoid this skill for marketing materials or non-technical user guides, or if the project lacks a defined technical structure.
Security analysis
SafeThe skill only uses Read, Write, Grep, and Glob to generate documentation; no network access, shell execution, or destructive commands. It poses no execution risk.
No concerns found
Examples
Write a comprehensive README for my Python project. The project is a CLI tool for managing Docker containers. Include installation instructions, usage examples, and a link to the changelog.Create a runbook for deploying the microservices application. Include prerequisites, step-by-step deployment commands, rollback steps, and monitoring checks.Generate architecture documentation for the e-commerce platform. Include a C4 diagram, component descriptions, and data flow between services.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.