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/workflows/greenfield/advanced.md
View on GitHub# Advanced Greenfield Topics
---
TOKEN_BUDGET: 200
TIER: 3
LOAD_TRIGGER: Multi-project, documentation packages, continuous docs
DEPENDENCIES: greenfield-workflow.md
---
## Multi-Project Documentation
When documenting multiple projects in a directory:
1. **Discover projects**: `find . -name 'pom.xml' -o -name 'package.json'`
2. **Detect framework** for each project
3. **Generate individual docs** for each
4. **Create overview document** linking all projects
5. **Generate system-wide C4 context diagram**
Output structure:
```
docs/
├── overview.md # Links to all project docs
├── c4-context.png # System-wide diagram
├── service-a/
│ ├── srs.md
│ └── api.yaml
└── service-b/
├── srs.md
└── api.yaml
```
## Documentation Packages
For release documentation packages:
1. Generate or update all document types:
- SRS (if high-risk features)
- PRD (for new features)
- SDD (architecture)
- API documentation
- User guide
- Deployment guide
2. Create all relevant diagrams
3. Convert to multiple formats (MD, DOCX, PDF)
4. Package in `docs-v{version}/` directory
5. Generate README index with links
## Custom Templates
To use a custom template:
```
Use my custom SRS template at templates/my-srs-template.md
```
Workflow:
1. Read custom template file
2. Identify placeholders in custom template
3. Apply same customization logic
4. Generate document using custom structure
## Continuous Documentation (Docs-as-Code)
Setup for CI/CD integration:
**Pre-commit hook**:
```bash
#!/bin/bash
# Validate documentation on commit
python scripts/validate-docs.py
```
**GitHub Actions**:
```yaml
- name: Validate Documentation
run: |
npm run docs:validate
npm run docs:build
```
**Key principles**:
- Update docs in same commit as code
- Automated validation in CI
- Documentation review in PR process
- Keep docs close to code
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 |