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/reference/05-api-checklist.md
View on GitHub# API Documentation: Checklist
---
TOKEN_BUDGET: 200
TIER: 3
LOAD_TRIGGER: On-demand when auditing API documentation
DEPENDENCIES: 05-api-openapi.md
---
## 5.3 API Documentation Checklist
### Essential Elements
- [ ] **Base URL and versioning** (e.g., `https://api.example.com/v1`, `/v2`)
- [ ] **Authentication method** (JWT, OAuth2, API key)
- [ ] How to obtain credentials
- [ ] How to include in requests (header, query param)
- [ ] Token expiration and refresh
- [ ] **All endpoints with HTTP methods** (GET, POST, PUT, DELETE, PATCH)
- [ ] **Request parameters** (query, path, body)
- [ ] Required vs. optional
- [ ] Data types and formats
- [ ] Validation rules
- [ ] **Request/response schemas** with examples
- [ ] **Status codes** (200, 201, 400, 401, 404, 500)
- [ ] What each code means
- [ ] Example responses for each code
- [ ] **Error responses with codes and messages**
- [ ] Error format structure
- [ ] Common error codes
- [ ] How to resolve errors
- [ ] **Rate limiting policies**
- [ ] Limits per endpoint
- [ ] Time windows
- [ ] Headers to check remaining quota
- [ ] **Code examples in multiple languages**
- [ ] cURL (minimum)
- [ ] Python, JavaScript, Java (recommended)
- [ ] Complete, runnable examples
- [ ] **Getting Started tutorial**
- [ ] Register for API key
- [ ] Make first API call
- [ ] Common workflows
- [ ] **Webhooks documentation** (if applicable)
- [ ] Available events
- [ ] Payload schemas
- [ ] Signature verification
### Quality Indicators
**Good API docs have:**
- ✅ Interactive sandbox or playground
- ✅ Searchable reference
- ✅ Conceptual guides (not just reference)
- ✅ Change log (versioned, dated)
- ✅ SDKs or client libraries
**Great API docs have:**
- ✅ Personalized with user's API key
- ✅ Code generators (Postman collections, SDKs)
- ✅ Real-world use case tutorials
- ✅ Performance and optimization tips
- ✅ Community forum or support channel
---
**End of API Documentation Checklist**
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 |