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/user-manual.md
View on GitHub# [Product Name] User Manual
**Version**: 1.0.0
**Last Updated**: [Date]
**Author**: [Name/Team]
---
## Table of Contents
1. [Introduction](#introduction)
2. [Getting Started](#getting-started)
3. [Features](#features)
4. [Troubleshooting](#troubleshooting)
5. [FAQ](#faq)
6. [Support](#support)
---
## Introduction
### What is [Product Name]?
[Brief description of the product/service - 2-3 sentences explaining what it does and who it's for]
### Who Should Use This Manual?
This manual is designed for [target audience: end-users, administrators, etc.] who want to [primary goal].
### Document Scope
This manual covers:
- ✅ [Main feature category 1]
- ✅ [Main feature category 2]
- ✅ [Main feature category 3]
- ❌ [What's NOT covered - refer to other docs]
---
## Getting Started
### Prerequisites
Before you begin, ensure you have:
- [ ] [Requirement 1, e.g., "An active account"]
- [ ] [Requirement 2, e.g., "Modern web browser (Chrome, Firefox, Safari)"]
- [ ] [Requirement 3, e.g., "Admin permissions (if applicable)"]
### First-Time Setup
#### Step 1: [Initial Setup Task]
1. Navigate to [location/URL]
2. Click [button/link]
3. Enter [required information]

*Figure 1: Setup screen showing [description]*
#### Step 2: [Configuration Task]
1. [Action 1]
2. [Action 2]
3. [Action 3]
**✅ Verification**: You should see [expected result]. If not, see [Troubleshooting](#troubleshooting).
### Quick Start Guide (5 Minutes)
To get up and running quickly:
1. **[First essential task]**: [Brief how-to]
2. **[Second essential task]**: [Brief how-to]
3. **[Third essential task]**: [Brief how-to]
---
## Features
### Feature 1: [Feature Name]
#### Overview
[Brief description of what this feature does and why users would use it]
#### How to Use
1. **Access the feature**:
- Navigate to [location]
- Click [button/menu item]

2. **Configure settings**:
- [Setting 1]: [Description and recommended value]
- [Setting 2]: [Description and recommended value]
3. **Perform main action**:
- [Step-by-step instructions]
#### Common Use Cases
- **Use Case 1**: [Scenario and how to accomplish it]
- **Use Case 2**: [Scenario and how to accomplish it]
#### Tips & Best Practices
💡 **Tip**: [Helpful advice]
⚠️ **Warning**: [Important caution]
---
### Feature 2: [Feature Name]
#### Overview
[Description]
#### How to Use
[Step-by-step instructions with screenshots]
#### Advanced Options
For advanced users:
- **Option 1**: [Description and when to use]
- **Option 2**: [Description and when to use]
---
### Feature 3: [Feature Name]
[Follow same pattern as Feature 1 and 2]
---
## Troubleshooting
### Common Issues
#### Issue: [Problem Description]
**Symptoms**: [What the user sees]
**Cause**: [Why it happens]
**Solution**:
1. [Step 1 to fix]
2. [Step 2 to fix]
3. [Step 3 to fix]
**Prevention**: [How to avoid this in the future]
---
#### Issue: [Another Problem]
[Follow same pattern]
---
### Error Messages
| Error Message | Meaning | Solution |
|---------------|---------|----------|
| "Error: [Message]" | [Explanation] | [Fix steps] |
| "Error: [Message]" | [Explanation] | [Fix steps] |
---
### System Requirements
**Minimum Requirements**:
- Browser: [Version requirements]
- Screen Resolution: [Minimum resolution]
- Internet: [Speed requirements]
**Recommended Requirements**:
- [Better specifications for optimal experience]
---
## FAQ
### General Questions
**Q: [Common question 1]?**
A: [Clear, concise answer]
**Q: [Common question 2]?**
A: [Clear, concise answer]
**Q: [Common question 3]?**
A: [Clear, concise answer]
### Account & Billing
**Q: [Billing question]?**
A: [Answer with link to billing support if needed]
### Technical Questions
**Q: [Technical question]?**
A: [Technical answer]
---
## Support
### Getting Help
**Documentation Resources**:
- 📘 [User Manual](link) (this document)
- 📗 [How-To Guides](link)
- 📙 [API Documentation](link)
- 📺 [Video Tutorials](link)
**Contact Support**:
- **Email**: support@example.com
- **Phone**: 1-800-XXX-XXXX (Mon-Fri 9AM-5PM EST)
- **Live Chat**: Available in-app
- **Help Center**: https://help.example.com
### Community Resources
- **Forum**: https://community.example.com
- **Knowledge Base**: https://kb.example.com
- **Status Page**: https://status.example.com
---
## Appendix
### Glossary
- **Term 1**: Definition
- **Term 2**: Definition
- **Term 3**: Definition
### Keyboard Shortcuts
| Action | Windows/Linux | macOS |
|--------|---------------|-------|
| [Action 1] | Ctrl+[Key] | Cmd+[Key] |
| [Action 2] | Ctrl+[Key] | Cmd+[Key] |
### Version History
| Version | Date | Changes |
|---------|------|---------|
| 1.0.0 | [Date] | Initial release |
---
**© [Year] [Company Name]. All rights reserved.**
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 |