Our review
Generates technical documentation including READMEs, specifications, architecture documents, and runbooks.
Strengths
- Uses standardized templates for consistency
- Incorporates Mermaid diagrams for visuals
- Provides clear file organization
Limitations
- Relies on provided templates which may not fit all cases
- Requires user feedback for refinement
- May not cover highly specialized documentation types
Use this skill when creating or updating technical documentation for a project.
Do not use it for creative or non-technical writing.
Security analysis
SafeThe skill only uses Read, Write, Grep, Glob tools, which perform local filesystem operations. It does not invoke external commands, network access, or destructive actions. There is no risk of data exfiltration or system compromise.
No concerns found
Examples
Write a comprehensive README for my Python project that includes installation, usage, and contribution guidelines.Create a runbook for deploying the microservice to production, including steps for rolling back.Document the architecture of the current system, including components, data flow, and a Mermaid 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.