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/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]

   ![Screenshot showing location](images/step1-location.png)
   *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]

   ![Screenshot of configuration](images/step2-config.png)
   *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]:

   ![Expected result](images/step3-result.png)
   *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]
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