Skip to content

SpillwaveSolutions/document-specialist-skill / skills/documentation-specialist

documentation-specialist

Verified

This 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".

FileKindSize
SKILL.mdskill md10.0 KB
references/examples/TOC.mdmarkdown6.5 KB
references/examples/brownfield/database-failover-runbook.mdmarkdown8.1 KB
references/examples/brownfield/spring-boot-sdd.mdmarkdown5.6 KB
references/examples/greenfield/adr-microservices.mdmarkdown6.3 KB
references/examples/greenfield/architecture-doc.mdmarkdown3.7 KB
references/examples/greenfield/billing-srs.mdmarkdown12.4 KB
references/examples/greenfield/cli-getting-started.mdmarkdown9.3 KB
references/examples/greenfield/collaboration-prd.mdmarkdown13.8 KB
references/examples/greenfield/document-specialist-sdd.mdmarkdown15.4 KB
references/examples/greenfield/ecommerce-sdd.mdmarkdown7.8 KB
references/examples/greenfield/rest-api-tutorial.mdmarkdown13.8 KB
references/examples/greenfield/task-api-openapi.yamlconfig19.0 KB
references/examples/greenfield/taskmanager-user-manual.mdmarkdown8.7 KB
references/examples/greenfield/ui-wireframes.mdmarkdown5.8 KB
references/guides/requirements/README.mdmarkdown3.7 KB
references/mappings/backend/fastapi-mapping.yamlconfig9.7 KB
references/mappings/backend/spring-boot-mapping.yamlconfig24.1 KB
references/reference/01-philosophy.mdmarkdown2.0 KB
references/reference/02-requirements-srs-vs-prd.mdmarkdown1.2 KB
references/reference/02-requirements-traceability.mdmarkdown1.7 KB
references/reference/02-requirements-writing.mdmarkdown1.4 KB
references/reference/03-design-adrs.mdmarkdown2.2 KB
references/reference/03-design-arc42.mdmarkdown2.6 KB
references/reference/03-design-requirements-matrix.mdmarkdown1.3 KB
references/reference/04-diagrams-c4-hierarchy.mdmarkdown2.0 KB
references/reference/04-diagrams-selection.mdmarkdown5.1 KB
references/reference/04-diagrams-state-vs-activity.mdmarkdown2.3 KB
references/reference/05-api-checklist.mdmarkdown2.0 KB
references/reference/05-api-openapi.mdmarkdown3.4 KB
references/reference/05-api-stripe-gold-standard.mdmarkdown1.8 KB
references/reference/06-deployment-diagrams.mdmarkdown1.8 KB
references/reference/06-deployment-documentation.mdmarkdown2.9 KB
references/reference/06-deployment-runbooks.mdmarkdown2.5 KB
references/reference/06-operational-docs.mdmarkdown2.7 KB
references/reference/07-user-kb-approach.mdmarkdown1.8 KB
references/reference/07-user-kb-template.mdmarkdown3.1 KB
references/reference/07-user-writing-style.mdmarkdown2.0 KB
references/reference/08-agile-process.mdmarkdown3.2 KB
references/reference/08-tutorial-writing.mdmarkdown7.4 KB
references/reference/09-code-to-docs-detection.mdmarkdown2.5 KB
references/reference/09-code-to-docs-example.mdmarkdown3.2 KB
references/reference/09-code-to-docs-when.mdmarkdown1.7 KB
references/reference/09-code-to-docs-workflow.mdmarkdown2.0 KB
references/reference/10-quality-bonsai-pruning.mdmarkdown2.4 KB
references/reference/10-quality-checklist.mdmarkdown2.6 KB
references/reference/10-quality-metrics.mdmarkdown3.1 KB
references/reference/11-voice-and-style.mdmarkdown1.5 KB
references/reference/comprehensive-guide.mdmarkdown7.3 KB
references/templates/markdown/DESIGN_DOC.mdmarkdown4.5 KB
references/templates/markdown/api-openapi.yamlconfig17.7 KB
references/templates/markdown/architecture.mdmarkdown1.6 KB
references/templates/markdown/design-sdd.mdmarkdown143 B
references/templates/markdown/developer-tutorial.mdmarkdown7.1 KB
references/templates/markdown/getting-started.mdmarkdown6.5 KB
references/templates/markdown/howto-guide.mdmarkdown4.1 KB
references/templates/markdown/requirements-prd.mdmarkdown10.2 KB
references/templates/markdown/requirements-srs.mdmarkdown17.0 KB
references/templates/markdown/runbook.mdmarkdown8.8 KB
references/templates/markdown/user-manual.mdmarkdown4.8 KB
references/workflows/TOC.mdmarkdown1.9 KB
references/workflows/audit-workflow.mdmarkdown2.5 KB
references/workflows/brownfield-workflow.mdmarkdown3.6 KB
references/workflows/brownfield/fastapi-guide.mdmarkdown1.8 KB
references/workflows/brownfield/pulumi-guide.mdmarkdown1.9 KB
references/workflows/brownfield/springboot-guide.mdmarkdown2.2 KB
references/workflows/convert-workflow.mdmarkdown1.4 KB
references/workflows/design-workflow.mdmarkdown3.0 KB
references/workflows/diagram-workflow.mdmarkdown3.7 KB
references/workflows/greenfield-workflow.mdmarkdown3.4 KB
references/workflows/greenfield/advanced.mdmarkdown1.9 KB
references/workflows/greenfield/openapi-guide.mdmarkdown2.5 KB
references/workflows/greenfield/prd-guide.mdmarkdown2.0 KB
references/workflows/greenfield/srs-guide.mdmarkdown2.0 KB
references/workflows/runbook-workflow.mdmarkdown2.4 KB
references/workflows/tutorial-workflow.mdmarkdown2.3 KB
references/workflows/user-docs-workflow.mdmarkdown2.3 KB

references/workflows/greenfield-workflow.md

View on GitHub
# Greenfield Documentation Workflow

---
TOKEN_BUDGET: 350
TIER: 2
LOAD_TRIGGER: Intent = CREATE_NEW
DEPENDENCIES: SKILL.md
---

## Overview

Create professional documentation from templates for new projects.

**Supported**: SRS, PRD, OpenAPI, User Manuals, How-To Guides, Getting Started, Tutorials, Runbooks

## Workflow Steps

### Step 1: Identify Document Type

| Request Contains | Document Type | Template |
|------------------|---------------|----------|
| "SRS", "requirements specification" | SRS | templates/markdown/requirements-srs.md |
| "PRD", "product requirements" | PRD | templates/markdown/requirements-prd.md |
| "OpenAPI", "API spec" | OpenAPI | templates/markdown/api-openapi.yaml |
| "user manual", "user guide" | User Manual | templates/markdown/user-manual.md |
| "how-to", "step-by-step" | How-To | templates/markdown/howto-guide.md |
| "getting started", "quick start" | Getting Started | templates/markdown/getting-started.md |
| "tutorial" | Tutorial | templates/markdown/developer-tutorial.md |
| "runbook", "procedure" | Runbook | templates/markdown/runbook.md |

### Step 2: Load Template

Read the appropriate template file. For detailed guidance on specific document types, load:
- SRS: [greenfield/srs-guide.md](greenfield/srs-guide.md)
- PRD: [greenfield/prd-guide.md](greenfield/prd-guide.md)
- OpenAPI: [greenfield/openapi-guide.md](greenfield/openapi-guide.md)

### Step 3: Extract Context

From the user request, extract:
1. **Project/Feature Name** - Subject of documentation
2. **Domain** - Healthcare, finance, e-commerce, etc.
3. **Key Requirements** - Explicitly mentioned requirements
4. **Constraints** - Compliance (HIPAA, PCI-DSS), performance, security
5. **Audience** - Developers, users, executives, auditors

### Step 4: Generate Content

1. Replace all `[Placeholder]` markers with actual content
2. Use **Given-When-Then** format for acceptance criteria
3. Add domain-specific examples
4. Include compliance requirements if mentioned
5. Assign unique IDs (FR-XXX-001, NFR-XXX-001)

### Step 5: Add Visuals

Present diagram generation options:
- C4, flowchart, sequence, class, ER, state → invoke `design-doc-mermaid` skill
- Wireframes, use case, timing, ArchiMate → invoke `plantuml` skill (always PNG or SVG)

### Step 6: Format & Save

Verify document includes:
- Front matter (title, version, date, author, status)
- Table of contents (if > 3 pages)
- Glossary for technical terms
- Consistent heading hierarchy

Save to: `docs/{category}/{project}-{doc-type}.md`

### Step 7: Post-Processing

Present options to user:
1. Convert to Word (DOCX)
2. Generate PDF
3. Create diagrams
4. Generate related documentation

## Quality Checklist

- [ ] Front matter complete
- [ ] Clear purpose in introduction
- [ ] Audience defined
- [ ] Requirements have unique IDs
- [ ] Acceptance criteria in Given-When-Then
- [ ] Glossary included
- [ ] Visuals offered

## Example Snippet

```markdown
## 3.1 User Authentication

**FR-AUTH-001**: User Login

**Description**: The system shall authenticate users with email/password.

**Acceptance Criteria**:
- **Given** a registered user with verified email
- **When** they enter correct credentials
- **Then** the system grants access with JWT token (1-hour expiry)

**Priority**: Must Have
```

For complete examples, see [examples/TOC.md](../examples/TOC.md).

---

**For advanced topics** (multi-project, documentation packages): [greenfield/advanced.md](greenfield/advanced.md)
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: 471kUpdated Claude CodeCodexVerifiedInstall
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: 471kUpdated Claude CodeCodexVerifiedInstall
rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics.Stars: 471kUpdated Claude CodeCodexVerifiedInstall
ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first.Stars: 194kUpdated Claude CodeCodexVerifiedInstall