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/templates/markdown/howto-guide.md
View on GitHub# How to [Accomplish Specific Task]
**Last Updated**: [Date]
**Difficulty**: [Beginner/Intermediate/Advanced]
**Estimated Time**: [X minutes]
---
## Overview
### What This Guide Covers
This guide will walk you through [specific task or goal] step-by-step.
### Who This Is For
This guide is designed for [target audience, e.g., "users who need to export data for analysis"].
### What You'll Accomplish
By the end of this guide, you will:
- ā
[Outcome 1]
- ā
[Outcome 2]
- ā
[Outcome 3]
---
## Prerequisites
Before you begin, make sure you have:
- [ ] [Requirement 1, e.g., "An active account with admin permissions"]
- [ ] [Requirement 2, e.g., "Data to export (at least one record)"]
- [ ] [Requirement 3, e.g., "Destination folder for exported files"]
---
## Instructions
### Step 1: [First Major Step]
[Brief explanation of what this step accomplishes and why it's necessary]
1. **[Sub-step 1]**:
- Navigate to [location]
- You should see [description of what's visible]

*Figure 1: [Description of screenshot]*
2. **[Sub-step 2]**:
- Click/Select [specific element]
- [Additional details if needed]
3. **[Sub-step 3]**:
- [Action to take]
- [Expected result]
š” **Tip**: [Helpful hint related to this step]
---
### Step 2: [Second Major Step]
[Brief explanation of this step]
1. **[Sub-step 1]**:
- [Detailed action]
- [What to expect]

*Figure 2: [Description]*
2. **[Sub-step 2]**:
- [Action]
- Choose from these options:
- **Option A**: [When to use this]
- **Option B**: [When to use this]
- **Option C**: [When to use this]
3. **[Sub-step 3]**:
- [Final action for this step]
ā ļø **Warning**: [Important caution - what NOT to do]
---
### Step 3: [Third Major Step]
[Brief explanation]
1. **[Sub-step 1]**:
- [Action]
2. **[Sub-step 2]**:
- [Action]
- You should see [expected result]:

*Figure 3: [Description of successful result]*
---
### Step 4: [Verification/Completion]
Verify that the task completed successfully:
1. **Check [indicator 1]**:
- Look for [specific sign of success]
- Location: [Where to find it]
2. **Verify [indicator 2]**:
- Confirm [expected state]
ā
**Success**: If you see [final confirmation], you're done!
---
## Example
### Sample Scenario
Let's walk through a complete example:
**Scenario**: [Concrete example situation]
**Steps**:
1. [Example step 1 with specific values]
- [Concrete action]
2. [Example step 2 with specific values]
- [Concrete action]
3. [Example step 3 with specific values]
- [Concrete action]
**Result**: [What the example achieves]
---
## Troubleshooting
### Common Issues
#### Problem: [Issue 1]
**Symptoms**:
- [What user sees/experiences]
**Cause**:
- [Why this happens]
**Solution**:
1. [Fix step 1]
2. [Fix step 2]
3. [Fix step 3]
---
#### Problem: [Issue 2]
**Symptoms**:
- [Description]
**Cause**:
- [Explanation]
**Solution**:
- [How to fix]
---
#### Problem: [Issue 3]
**What it means**: [Explanation]
**How to fix**: [Solution]
---
## Tips & Best Practices
### Do's ā
- ā
[Best practice 1]
- ā
[Best practice 2]
- ā
[Best practice 3]
### Don'ts ā
- ā [Common mistake 1]
- ā [Common mistake 2]
- ā [Common mistake 3]
### Performance Tips
š” **Optimize by**: [Performance advice]
š” **Avoid slowdowns**: [What to avoid]
---
## Related Guides
**Before This Guide**:
- [Prerequisite guide if any]
**After This Guide**:
- [Next logical step guide]
- [Related advanced guide]
**Related Topics**:
- [Related guide 1]
- [Related guide 2]
---
## Need More Help?
If you encounter issues not covered in this guide:
š§ **Email**: support@example.com
š¬ **Live Chat**: Available in-app
š **Knowledge Base**: https://kb.example.com
š„ **Video Tutorial**: [Link if available]
---
## Feedback
Help us improve this guide!
- š Was this guide helpful? [Feedback link]
- š¬ Have suggestions? [Feedback link]
- š Found an error? [Report link]
---
**Last Reviewed**: [Date]
**Applies to Version**: [Product version]
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 |