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/brownfield-workflow.md

View on GitHub
# Brownfield Code-to-Docs Workflow

---
TOKEN_BUDGET: 400
TIER: 2
LOAD_TRIGGER: Intent = CODE_TO_DOCS
DEPENDENCIES: SKILL.md
---

## Overview

Reverse-engineer professional documentation from existing codebases.

**Supported Frameworks**:
- **Backend**: Spring Boot, FastAPI, Express.js, Django
- **Infrastructure**: Pulumi, Terraform
- **Frontend**: React, Next.js

## Workflow Steps

### Step 1: Framework Detection

Use Glob + Grep to identify framework:

| Framework | Detection Files | Confirm Pattern |
|-----------|----------------|-----------------|
| Spring Boot | `pom.xml`, `build.gradle` | `@SpringBootApplication` |
| FastAPI | `requirements.txt` | `from fastapi import` |
| Express.js | `package.json` | `const express =` |
| Pulumi | `Pulumi.yaml` | `import pulumi` |
| Terraform | `*.tf` | `resource "aws_` |
| React | `package.json` | `"react":` |

**If detected**: Load mapping from `mappings/{category}/{framework}-mapping.yaml`
**If not detected**: Request framework clarification from user

### Step 2: Load Framework Mapping

Read the framework-specific mapping file for extraction rules.

For detailed guidance, load:
- Spring Boot: [brownfield/springboot-guide.md](brownfield/springboot-guide.md)
- FastAPI: [brownfield/fastapi-guide.md](brownfield/fastapi-guide.md)
- Pulumi: [brownfield/pulumi-guide.md](brownfield/pulumi-guide.md)

### Step 3: 6-Step Code Analysis

| Step | What to Extract | How |
|------|-----------------|-----|
| 3.1 Architecture | Entry point, external systems, config | Read config files, main class |
| 3.2 API | Endpoints, methods, parameters | Grep for route decorators |
| 3.3 Data Model | Entities, relationships, constraints | Grep for entity annotations |
| 3.4 Business Logic | Services, workflows, transactions | Grep for service classes |
| 3.5 Security | Auth method, authorization rules | Read security config |
| 3.6 Deployment | Database, Docker, K8s config | Read deployment files |

### Step 4: Generate Documentation

**For Backend Apps**:
1. Software Design Document (SDD) - arc42 format
2. OpenAPI 3.0 Specification
3. Diagrams: C4 Container, Component, ER, Sequence

**For Infrastructure**:
1. Deployment Architecture Document
2. Diagrams: C4 Infrastructure, Deployment Topology

**Save to**: `docs/design/`, `docs/api/`, `docs/diagrams/`

### Step 5: Invoke Diagram Skills

Invoke appropriate diagram skills:
- **design-doc-mermaid**: C4, flowchart, sequence, class, ER, state, component views
- **plantuml**: Salt wireframes, use case, timing, ArchiMate. Always PNG or SVG.

### Step 6: Format & Save

Verify documents include:
- Front matter (title, version, date, generator)
- Table of contents
- Code references with file paths
- Glossary of framework terms

### Step 7: Post-Processing

Present options to user:
1. Convert SDD to Word (DOCX)
2. Generate PDF package
3. Render diagrams to PNG
4. Create sequence diagrams for specific flows

## Quality Checklist

- [ ] Framework detected and confirmed
- [ ] Mapping file loaded
- [ ] All 6 extraction steps completed
- [ ] SDD generated (arc42 format)
- [ ] OpenAPI generated (backend only)
- [ ] Diagrams generated
- [ ] Code references include file paths
- [ ] Glossary includes framework terms

## Example Snippet

```markdown
### 3.2 API Extraction (Spring Boot)

Grep: "@RestController" → Found OrderController.java

Endpoints extracted:
- GET /api/v1/orders → List orders
- POST /api/v1/orders → Create order
- GET /api/v1/orders/{id} → Get order by ID
```

For complete examples: [examples/brownfield/](../examples/brownfield/)

---

**Framework-specific guides**: See `brownfield/` subdirectory
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