documentation-specialist

What problem does it solve?

The Documentation Specialist accelerates the creation and maintenance of software documentation, reduces manual writing time, and minimizes token waste by using Progressive Disclosure Architecture (PDA). It supports greenfield templated docs, brownfield code-to-docs extraction, audits, format conversions, and diagram generation to keep docs accurate and up-to-date with minimal effort.

Core Features & Use Cases

• Greenfield Documentation: generate IEEE SRS, PRD, OpenAPI specs, user manuals, tutorials, and runbooks from templates.
• Brownfield Documentation: reverse-engineer documentation from existing codebases (e.g., Spring Boot, Pulumi).
• Documentation Audit: review and improve existing documentation for clarity, completeness, and compliance.
• Format Conversion & Diagrams: convert between Markdown, DOCX, PDF and generate architecture diagrams (Mermaid, PlantUML, ER).
• On-Demand Loading: load only the necessary workflows, references, templates, and examples to minimize token usage.
• Examples & Guidance: learn from production-quality examples to accelerate documentation work.

Quick Start

1. Describe your documentation need, e.g., "Create an SRS for a HIPAA-compliant patient portal."
2. The skill classifies the intent and loads the appropriate greenfield workflow and template.
3. The skill generates the customized documentation and saves it to your docs folder.
4. Optionally convert to PDF or add diagrams using additional skills.