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/tutorial-workflow.md
View on GitHub# Tutorial and Developer Guide Workflow
---
TOKEN_BUDGET: 300
TIER: 2
LOAD_TRIGGER: Intent = CREATE_TUTORIAL
DEPENDENCIES: SKILL.md
---
## Overview
Create developer-focused tutorials, API guides, and CLI documentation.
**Supported**: Developer Tutorials, API Usage Guides, CLI Documentation
## Workflow Steps
### Step 1: Identify Document Type
| Keywords | Type | Template |
|----------|------|----------|
| "tutorial", "walkthrough" | Developer Tutorial | templates/markdown/developer-tutorial.md |
| "API guide", "integration" | API Usage Guide | (use tutorial template) |
| "CLI docs", "command reference" | CLI Documentation | (use getting-started template) |
### Step 2: Load Template
Read template and reference if needed:
- Tutorial writing: [08-tutorial-writing.md](../reference/08-tutorial-writing.md)
- Example: [rest-api-tutorial.md](../examples/greenfield/rest-api-tutorial.md)
### Step 3: Gather Context
Extract from user request:
1. **Topic** - Technology/API/tool being covered
2. **Goal** - What reader will build or learn
3. **Audience** - Beginner/intermediate/advanced level
4. **Prerequisites** - Languages, tools, accounts needed
### Step 4: Generate Content
**Developer Tutorial Structure**:
1. Introduction (what you'll build)
2. Prerequisites
3. Project setup
4. Step-by-step implementation (with code)
5. Testing
6. Conclusion & next steps
**API Usage Guide Structure**:
1. Overview (what the API does)
2. Authentication setup
3. Making your first request
4. Common use cases (with code examples)
5. Error handling
6. Reference to full API docs
**CLI Documentation Structure**:
1. Installation
2. Basic usage
3. Command reference (alphabetical)
4. Configuration
5. Examples
### Step 5: Apply Tutorial Best Practices
- **Working code**: Every example must run
- **Progressive complexity**: Build on previous steps
- **Explain the "why"**: Not just "what" to do
- **Multiple languages**: Python, JavaScript, curl examples
- **Copy-pasteable**: Code blocks with language tags
### Step 6: Format & Save
Save to: `docs/tutorials/{topic}-tutorial.md`
Present options to user:
1. Generate Jupyter notebook version
2. Create video script
3. Add more code examples
## Quality Checklist
- [ ] Clear learning objective
- [ ] Prerequisites listed
- [ ] All code examples tested
- [ ] Language tags on code blocks
- [ ] Progressive difficulty
- [ ] Next steps provided
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 |