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/09-code-to-docs-when.md
View on GitHub# Code-to-Docs: When to Use Brownfield Documentation
---
TOKEN_BUDGET: 150
TIER: 3
LOAD_TRIGGER: On-demand when reverse-engineering documentation from code
DEPENDENCIES: None
---
## 9.1 When to Use Brownfield Documentation
### Use Cases
**1. Inherited Legacy Codebase**
- No documentation exists
- Original developers have left
- Need to understand before making changes
**2. Open-Source Project Adoption**
- Evaluating whether to use a library
- Contributing to a project
- Onboarding team to new dependency
**3. Onboarding New Team Members**
- Reduce ramp-up time from weeks to days
- Provide high-level architecture overview
- Document undocumented tribal knowledge
**4. Compliance Audit Requirements**
- SOC 2, HIPAA, PCI-DSS audits
- Need formal documentation of existing systems
- Demonstrate security controls
**5. Architecture Review**
- Planning a major refactoring
- Identifying technical debt
- Evaluating scalability
**6. M&A Due Diligence**
- Acquiring a company or product
- Need to understand what you're buying
- Assess code quality and maintainability
---
### When NOT to Use
**Don't use brownfield documentation when:**
- Code is already well-documented
- Building a greenfield project (use templates instead)
- Code is being rewritten (document the new design)
- Time is better spent refactoring than documenting
---
### ROI Calculation
**Investment**: 2-4 hours to generate brownfield documentation
**Return**:
- Onboarding time reduced by 50% (weeks → days)
- Fewer incidents due to better understanding
- Faster feature development (less time spelunking code)
- Reduced bus factor (knowledge not trapped in one person's head)
---
**End of When to Use Brownfield Documentation Guide**
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: 471k | 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: 471k | 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: 471k | 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 |