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-workflow.md
View on GitHub# Code-to-Docs: Extraction Workflow
---
TOKEN_BUDGET: 180
TIER: 3
LOAD_TRIGGER: On-demand when executing brownfield documentation generation
DEPENDENCIES: 09-code-to-docs-detection.md
---
## 9.3 Extraction Workflow
### 7-Step Process
**Step 1: Detect Framework**
- Scan for key files (Glob)
- Confirm framework patterns (Grep)
- Load framework mapping
**Step 2: Load Mapping**
- Use framework-specific extraction rules
- Example: `mappings/backend/spring-boot-mapping.yaml`
**Step 3: Scan Codebase**
- Use Glob and Grep to find components
- Example: Find all `@RestController` classes
**Step 4: Read Key Files**
- Extract relevant code elements
- Example: Read controller methods, entity classes
**Step 5: Map to Documentation**
- Apply mapping rules (code → doc sections)
- Example: `@GetMapping("/api/tasks")` → OpenAPI GET endpoint
**Step 6: Generate Artifacts**
- Create SDD, API docs, diagrams
- Example: Generate arc42 SDD, OpenAPI spec, C4 diagram
**Step 7: Post-Process**
- Offer conversions (MD → DOCX → PDF)
- Offer additional diagrams (ER, sequence)
---
### Mapping Rules Example
**Spring Boot Mapping:**
```yaml
architecture:
entry_point:
pattern: "@SpringBootApplication"
extract: "Application class, port, profiles"
api:
controller:
pattern: "@RestController"
extract: "Endpoints, methods, paths, parameters"
data:
entity:
pattern: "@Entity"
extract: "Tables, columns, relationships"
business_logic:
service:
pattern: "@Service"
extract: "Business operations"
security:
config:
pattern: "SecurityConfig"
extract: "Auth methods, protected endpoints"
```
---
### Progressive Extraction
**Start Minimal**:
1. System context (what is this?)
2. Architecture overview (how is it structured?)
3. API surface (what are the endpoints?)
**Expand as Needed**:
4. Data model (database schema)
5. Business logic (service layer)
6. Security (authentication, authorization)
7. Deployment (infrastructure, config)
---
**End of Code-to-Docs Extraction Workflow 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 |