Our review
Generates comprehensive technical documentation (READMEs, specifications, architectures, runbooks) using templates and best practices.
Strengths
- Leverages structured and proven templates
- Integrates Mermaid diagrams for clear visualizations
- Provides logical file organization guidance
- Follows an iterative process with review and feedback
Limitations
- Requires pre-existing templates in a designated folder
- May produce overly generic content without advanced customization
- Depends on asking the right questions to fully understand context
When you need to create or update formal technical documentation for a project, API, or operational process.
For informal or very brief documentation (e.g., code comments) or when the project is still too unstable to document.
Security analysis
SafeThe skill only uses Read, Write, Grep, and Glob tools to generate documentation. There are no destructive commands, no network access, and no execution of external code. The templates use placeholders and do not introduce any risk.
No concerns found
Examples
Generate a comprehensive README for my Python project that includes installation, usage, configuration, and contributing guidelines. Use the standard README template from the skills templates folder.Create a runbook for deploying my web application to production. Include steps for pre-deployment checks, deployment execution, and post-deployment monitoring. Use the runbook template.Write a technical specification for the REST API of my project, covering authentication, endpoints, request/response formats, and error handling. Follow the API documentation template.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.
Typed Documentation Forms System
Documentation
Add typed comments, documentation, todos, and metadata to Scheme code using `(doc ...)` forms. Doc annotations are authoritative for type inference, extracted by search commands (lf-todo, lf-types), and integrated with the type checker and LSP. Useful for annotating functions, marking deprecations, or tracking localized improvements alongside the code.