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/07-user-kb-approach.md
View on GitHub# User Documentation: Knowledge Base Approach
---
TOKEN_BUDGET: 200
TIER: 3
LOAD_TRIGGER: On-demand when creating user documentation or knowledge base articles
DEPENDENCIES: None
---
## 7.1 From Static Manuals to Dynamic Knowledge Bases
### Old Model
100-page PDF user manual that:
- Gets outdated immediately
- Is hard to search
- Covers features users don't need
- Requires downloading and reading linearly
### New Model
Dynamic, searchable Knowledge Base (KB) or Help Center that:
- Updates with every product release
- Users can search and find answers in seconds
- Covers user goals, not just features
- Integrates with the product (contextual help)
---
### Key Features of Modern Knowledge Bases
**1. Prominent Search**
- Users "Google" their problem
- Search should be on every page
- Use autocomplete suggestions
- Track searches with no results (content gaps)
**2. Logical Categories**
- Grouped by user goals, not features
- Examples:
- ✅ "Getting Started"
- ✅ "Managing Tasks"
- ✅ "Collaborating with Teams"
- ❌ "Settings Menu"
**3. Multimedia**
- Screenshots with annotations (red boxes, arrows)
- Animated GIFs for workflows
- Short screen-capture videos (<2 minutes)
- Interactive demos
**4. Feedback Loops**
- "Was this helpful? [Yes] [No]" on every article
- Track which articles get negative feedback
- Allow users to suggest improvements
**5. Analytics**
- What are users searching for?
- Which articles get the most views?
- Where do users drop off?
- What searches return no results?
**6. Contextual Support**
- In-app help widgets
- Tooltips and inline help
- "Learn more" links to KB articles
- Chatbot for common questions
---
### Popular KB Platforms
- Zendesk Guide
- Intercom Articles
- Help Scout Docs
- GitBook
- Confluence (internal)
- Notion (internal)
---
**End of Knowledge Base Approach 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 |