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-stripe-gold-standard.md
View on GitHub# API Documentation: The Stripe Gold Standard
---
TOKEN_BUDGET: 180
TIER: 3
LOAD_TRIGGER: On-demand when creating API documentation
DEPENDENCIES: None
---
## 5.1 The Gold Standard: Stripe API
Stripe's API documentation is widely considered the best. Key features:
### 1. Three-Column Layout
- **Left**: Navigation (organized by resource)
- **Middle**: Conceptual explanation, parameter descriptions
- **Right**: Interactive code examples in multiple languages
**Benefit**: Users can read and try code simultaneously
---
### 2. Core Concepts First
Teaches the model before teaching the methods.
**Example**: Before showing PaymentIntent endpoints, explains the PaymentIntent state machine and lifecycle.
**Benefit**: Users understand the "why" before the "how"
---
### 3. Interactive & Personalized
- Pre-filled with user's test API keys
- Click "Run" to execute API calls in sandbox
- See real responses
**Benefit**: Reduces time-to-first-API-call from hours to minutes
---
### 4. Clear Auth & Errors
- **Authentication**: Dedicated page explaining Bearer tokens, test vs. live keys
- **Errors**: Comprehensive error codes with explanations and solutions
**Benefit**: Reduces support burden for common issues
---
### 5. Code Examples in Multiple Languages
- cURL (for testing)
- Python, Ruby, Node.js, PHP, Java, Go (for implementation)
- Each example is complete and runnable
**Benefit**: Developers can copy-paste to get started quickly
---
### Lessons for Your API Docs
1. **Teach concepts first**: Don't just list endpoints
2. **Make it interactive**: Sandbox or code playground
3. **Show complete examples**: Not just request, but full response too
4. **Organize by user goal**: "Accept a payment" not "POST /charges"
5. **Invest in search**: Users should find answers in <30 seconds
---
**End of Stripe Gold Standard Guide**
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: 472k | 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: 472k | 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: 472k | 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 |