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/brownfield/fastapi-guide.md
View on GitHub# FastAPI Code-to-Docs Guide
---
TOKEN_BUDGET: 250
TIER: 3
LOAD_TRIGGER: CODE_TO_DOCS + FastAPI detected
DEPENDENCIES: brownfield-workflow.md
---
## Detection
```
Glob: "requirements.txt" or "pyproject.toml"
Grep: "from fastapi import|fastapi"
Grep: "app = FastAPI()"
```
## Extraction Commands
### Architecture (Step 3.1)
```
Grep: "app = FastAPI()" → Main app instance
Read: main.py or app.py → App configuration
Read: config.py or settings.py → Settings
Grep: "BaseSettings" → Pydantic settings
```
### API (Step 3.2)
```
Grep: "@app.get|@app.post|@app.put|@app.delete"
Grep: "@router.get|@router.post" → APIRouter endpoints
For each route:
Extract: Path, parameters, response_model, dependencies
```
### Data Model (Step 3.3)
```
Grep: "class.*BaseModel" → Pydantic models
Grep: "class.*Base.*Model" → SQLAlchemy models (if used)
Grep: "Column\(|relationship\(" → SQLAlchemy fields
```
### Business Logic (Step 3.4)
```
Read: services/*.py → Service functions
Grep: "async def" → Async operations
Grep: "Depends\(" → Dependency injection
```
### Security (Step 3.5)
```
Grep: "OAuth2PasswordBearer|HTTPBearer"
Grep: "Depends.*get_current_user"
Read: auth.py or security.py
```
### Deployment (Step 3.6)
```
Read: Dockerfile
Read: docker-compose.yml
Grep: "uvicorn|gunicorn" → ASGI server config
```
## Output Files
| Artifact | Location |
|----------|----------|
| SDD | `docs/design/{project}-sdd.md` |
| OpenAPI | `docs/api/{project}-openapi.yaml` |
| C4 Diagram | `docs/diagrams/c4-container.md` |
## FastAPI Advantage
FastAPI auto-generates OpenAPI! Check for existing:
```
Read: /openapi.json endpoint output
```
If available, use as base and enhance with additional context.
For mapping file: [fastapi-mapping.yaml](../../mappings/backend/fastapi-mapping.yaml)
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 |