Skip to content

SpillwaveSolutions/document-specialist-skill / skills/documentation-specialist

documentation-specialist

Verified

This 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".

FileKindSize
SKILL.mdskill md10.0 KB
references/examples/TOC.mdmarkdown6.5 KB
references/examples/brownfield/database-failover-runbook.mdmarkdown8.1 KB
references/examples/brownfield/spring-boot-sdd.mdmarkdown5.6 KB
references/examples/greenfield/adr-microservices.mdmarkdown6.3 KB
references/examples/greenfield/architecture-doc.mdmarkdown3.7 KB
references/examples/greenfield/billing-srs.mdmarkdown12.4 KB
references/examples/greenfield/cli-getting-started.mdmarkdown9.3 KB
references/examples/greenfield/collaboration-prd.mdmarkdown13.8 KB
references/examples/greenfield/document-specialist-sdd.mdmarkdown15.4 KB
references/examples/greenfield/ecommerce-sdd.mdmarkdown7.8 KB
references/examples/greenfield/rest-api-tutorial.mdmarkdown13.8 KB
references/examples/greenfield/task-api-openapi.yamlconfig19.0 KB
references/examples/greenfield/taskmanager-user-manual.mdmarkdown8.7 KB
references/examples/greenfield/ui-wireframes.mdmarkdown5.8 KB
references/guides/requirements/README.mdmarkdown3.7 KB
references/mappings/backend/fastapi-mapping.yamlconfig9.7 KB
references/mappings/backend/spring-boot-mapping.yamlconfig24.1 KB
references/reference/01-philosophy.mdmarkdown2.0 KB
references/reference/02-requirements-srs-vs-prd.mdmarkdown1.2 KB
references/reference/02-requirements-traceability.mdmarkdown1.7 KB
references/reference/02-requirements-writing.mdmarkdown1.4 KB
references/reference/03-design-adrs.mdmarkdown2.2 KB
references/reference/03-design-arc42.mdmarkdown2.6 KB
references/reference/03-design-requirements-matrix.mdmarkdown1.3 KB
references/reference/04-diagrams-c4-hierarchy.mdmarkdown2.0 KB
references/reference/04-diagrams-selection.mdmarkdown5.1 KB
references/reference/04-diagrams-state-vs-activity.mdmarkdown2.3 KB
references/reference/05-api-checklist.mdmarkdown2.0 KB
references/reference/05-api-openapi.mdmarkdown3.4 KB
references/reference/05-api-stripe-gold-standard.mdmarkdown1.8 KB
references/reference/06-deployment-diagrams.mdmarkdown1.8 KB
references/reference/06-deployment-documentation.mdmarkdown2.9 KB
references/reference/06-deployment-runbooks.mdmarkdown2.5 KB
references/reference/06-operational-docs.mdmarkdown2.7 KB
references/reference/07-user-kb-approach.mdmarkdown1.8 KB
references/reference/07-user-kb-template.mdmarkdown3.1 KB
references/reference/07-user-writing-style.mdmarkdown2.0 KB
references/reference/08-agile-process.mdmarkdown3.2 KB
references/reference/08-tutorial-writing.mdmarkdown7.4 KB
references/reference/09-code-to-docs-detection.mdmarkdown2.5 KB
references/reference/09-code-to-docs-example.mdmarkdown3.2 KB
references/reference/09-code-to-docs-when.mdmarkdown1.7 KB
references/reference/09-code-to-docs-workflow.mdmarkdown2.0 KB
references/reference/10-quality-bonsai-pruning.mdmarkdown2.4 KB
references/reference/10-quality-checklist.mdmarkdown2.6 KB
references/reference/10-quality-metrics.mdmarkdown3.1 KB
references/reference/11-voice-and-style.mdmarkdown1.5 KB
references/reference/comprehensive-guide.mdmarkdown7.3 KB
references/templates/markdown/DESIGN_DOC.mdmarkdown4.5 KB
references/templates/markdown/api-openapi.yamlconfig17.7 KB
references/templates/markdown/architecture.mdmarkdown1.6 KB
references/templates/markdown/design-sdd.mdmarkdown143 B
references/templates/markdown/developer-tutorial.mdmarkdown7.1 KB
references/templates/markdown/getting-started.mdmarkdown6.5 KB
references/templates/markdown/howto-guide.mdmarkdown4.1 KB
references/templates/markdown/requirements-prd.mdmarkdown10.2 KB
references/templates/markdown/requirements-srs.mdmarkdown17.0 KB
references/templates/markdown/runbook.mdmarkdown8.8 KB
references/templates/markdown/user-manual.mdmarkdown4.8 KB
references/workflows/TOC.mdmarkdown1.9 KB
references/workflows/audit-workflow.mdmarkdown2.5 KB
references/workflows/brownfield-workflow.mdmarkdown3.6 KB
references/workflows/brownfield/fastapi-guide.mdmarkdown1.8 KB
references/workflows/brownfield/pulumi-guide.mdmarkdown1.9 KB
references/workflows/brownfield/springboot-guide.mdmarkdown2.2 KB
references/workflows/convert-workflow.mdmarkdown1.4 KB
references/workflows/design-workflow.mdmarkdown3.0 KB
references/workflows/diagram-workflow.mdmarkdown3.7 KB
references/workflows/greenfield-workflow.mdmarkdown3.4 KB
references/workflows/greenfield/advanced.mdmarkdown1.9 KB
references/workflows/greenfield/openapi-guide.mdmarkdown2.5 KB
references/workflows/greenfield/prd-guide.mdmarkdown2.0 KB
references/workflows/greenfield/srs-guide.mdmarkdown2.0 KB
references/workflows/runbook-workflow.mdmarkdown2.4 KB
references/workflows/tutorial-workflow.mdmarkdown2.3 KB
references/workflows/user-docs-workflow.mdmarkdown2.3 KB

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]

   ![Setup screen](images/setup-screen.png)
   *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]

   ![Feature location](images/feature1-location.png)

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.**
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: 472kUpdated Claude CodeCodexVerifiedInstall
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: 472kUpdated Claude CodeCodexVerifiedInstall
rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first.Stars: 194kUpdated Claude CodeCodexVerifiedInstall