SpillwaveSolutions/document-specialist-skill / skills/documentation-specialist
documentation-specialist
VerifiedThis skill should be used when creating professional software documentation (SRS, PRD, OpenAPI, SDD, architecture docs, user manuals, tutorials, runbooks) from templates (greenfield) or reverse-engineering documentation from existing code like Spring Boot or FastAPI (brownfield). Also handles documentation audits/reviews, format conversion (Markdown, DOCX, PDF), and diagram generation (Mermaid first: C4, sequence, class, ER, state, flowchart; PlantUML Salt for UI wireframes and leftover UML). Use when asked to "create documentation", "document my code", "write SRS", "generate PRD", "write DESIGN_DOC.md", "architecture document", "wireframe", or "documentation specialist".
references/reference/10-quality-checklist.md
View on GitHub# Quality: Documentation Quality Checklist
---
TOKEN_BUDGET: 220
TIER: 3
LOAD_TRIGGER: On-demand when auditing documentation quality
DEPENDENCIES: None
---
## 10.1 Documentation Quality Checklist
### All Documents
- [ ] **Clear, descriptive title**
- Tells reader what the doc is about
- Specific, not generic
- [ ] **Version number and date**
- Semantic versioning (v1.0.0, v1.1.0)
- Last updated date (YYYY-MM-DD format)
- [ ] **Author/owner identified**
- Who wrote this?
- Who maintains it?
- Contact for questions
- [ ] **Table of contents** (if > 3 pages)
- Hyperlinked headings
- Helps navigation
- [ ] **Introduction** (purpose, scope, audience)
- What is this document?
- Who is it for?
- What's in scope / out of scope?
- [ ] **Glossary of terms**
- Define acronyms and jargon
- Consistent terminology
- [ ] **Consistent formatting**
- Same heading styles
- Same code block styles
- Same list formatting
- [ ] **No spelling or grammar errors**
- Use spell checker
- Proofread before publishing
- [ ] **All acronyms defined on first use**
- Example: "API (Application Programming Interface)"
---
### Technical Documents (SDD, API Docs, Deployment)
- [ ] **Code examples are tested**
- Examples actually work
- Not pseudo-code
- [ ] **Diagrams are up-to-date**
- Match current architecture
- Source files available for editing
- [ ] **Links are not broken**
- Test all hyperlinks
- Use relative paths for internal links
- [ ] **Version-specific** (not "latest")
- Document version 2.1.0, not "the current version"
- Warn if documentation is for older version
---
### Requirements Documents (SRS, PRD)
- [ ] **Unique IDs**: All requirements have FR-XXX-001 format
- [ ] **Testable**: Each requirement is measurable/verifiable
- [ ] **Atomic**: One requirement per ID
- [ ] **Acceptance criteria**: Given-When-Then format provided
- [ ] **Priority**: Must-have, Should-have, Nice-to-have
- [ ] **Traceability**: Linked to design and tests
---
### API Documentation (OpenAPI)
- [ ] **Base URL**: Production, staging URLs defined
- [ ] **Authentication**: Auth method specified
- [ ] **All endpoints documented**
- [ ] **Request/response examples**
- [ ] **Error codes**: All status codes explained
- [ ] **Rate limits**: Documented
---
### User Documentation (KB Articles)
- [ ] **Title is goal-oriented**: "How to..." or "What is..."
- [ ] **Screenshots**: Annotated, current UI
- [ ] **Step-by-step**: Numbered instructions
- [ ] **Expected outcome**: What happens after following steps
- [ ] **Troubleshooting**: Common issues addressed
---
**End of Documentation Quality Checklist**
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |