Documentation Specialist Skill
Quick Start
Software documentation creation, extraction, conversion, and diagramming capabilities.
Capabilities:
- Greenfield - Create documentation from templates (SRS, PRD, OpenAPI, User Manuals, Tutorials, Runbooks)
- Brownfield - Reverse-engineer documentation from code (Spring Boot, FastAPI)
- Audit - Review and improve existing documentation
- Convert - Transform formats (MD → DOCX → PDF)
- Diagram - Generate visuals (Mermaid C4, PlantUML UML)
Example Requests:
Create an SRS for a billing system with PCI-DSS compliance
Document my Spring Boot application at ~/projects/customer-api
Create a user manual for my SaaS product
Write a database failover runbook
Audit my API documentation at docs/api/openapi.yaml
Convert docs/srs.md to Word format
Create a C4 container diagram for my microservicesExecution Flow:
- Classify intent → 2. Load workflow → 3. Execute steps → 4. Generate documentation → 5. Present post-processing options
Intent Classification
| Intent | Keywords | Workflow |
|---|---|---|
| CREATE_NEW | "create", "generate", "write" + doc type | greenfield-workflow.md |
| CODE_TO_DOCS | "document", "extract", path reference | brownfield-workflow.md |
| AUDIT | "audit", "review", "check", "improve" | audit-workflow.md |
| CONVERT | "convert", "to Word", "to PDF" | convert-workflow.md |
| DIAGRAM | "diagram", "C4", "sequence", "ER" | diagram-workflow.md |
| USER_DOCS | "user manual", "how-to", "getting started" | user-docs-workflow.md |
| TUTORIAL | "tutorial", "API guide", "CLI docs" | tutorial-workflow.md |
| RUNBOOK | "runbook", "procedure", "incident" | runbook-workflow.md |
CRITICAL: Load only the workflow needed for the current intent. Avoid loading multiple workflows.
Document Type → Template
Requirements & Design:
| Type | Template |
|---|---|
| SRS | requirements-srs.md |
| PRD | requirements-prd.md |
| OpenAPI | api-openapi.yaml |
User Documentation:
| Type | Template |
|---|---|
| User Manual | user-manual.md |
| How-To Guide | howto-guide.md |
| Getting Started | getting-started.md |
Developer & Operations:
| Type | Template |
|---|---|
| Developer Tutorial | developer-tutorial.md |
| Runbook | runbook.md |
Framework Detection (Brownfield)
| Framework | Detection | Mapping |
|---|---|---|
| Spring Boot | pom.xml, @SpringBootApplication | spring-boot-mapping.yaml |
| FastAPI | requirements.txt, from fastapi import | fastapi-mapping.yaml |
Process: Glob for detection files → Grep for patterns → Load mapping → Follow brownfield workflow
On-Demand Resources
Load only what is needed for the current task.
Workflows
- Workflow TOC - Navigation index
- greenfield-workflow.md
- brownfield-workflow.md
- audit-workflow.md
- convert-workflow.md
- diagram-workflow.md
- user-docs-workflow.md
- tutorial-workflow.md
- runbook-workflow.md
Reference Guides
- comprehensive-guide.md - Navigation to all 27 reference guides
Examples
- Examples TOC - Navigation to all examples
Skill Integration
| Skill | Invocation Trigger |
|---|---|
| docx | Request includes Word format |
| Request includes PDF format | |
| plantuml | UML diagrams (ER, sequence, component) |
| mermaid-architect | C4 diagrams, flowcharts |
Error Handling
| Error | Response |
|---|---|
| Cannot detect framework | Ask: "Is this Spring Boot, FastAPI, or another framework?" |
| Missing template | Use closest match, inform user |
| Skill not available | Offer markdown-only alternative |
| Ambiguous request | Ask: "Would you prefer SRS (formal) or PRD (agile)?" |
End of SKILL.md (v3.0-PDA)