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/getting-started.md
View on GitHub# Getting Started with [Product/Tool/Framework Name]
**Version**: [Version number]
**Last Updated**: [Date]
---
## Introduction
### What is [Product Name]?
[2-3 sentence description of what it is, what problem it solves, and who it's for]
### Why Use [Product Name]?
- **[Benefit 1]**: [Explanation]
- **[Benefit 2]**: [Explanation]
- **[Benefit 3]**: [Explanation]
### Target Audience
This guide is for [specific audience, e.g., "developers familiar with JavaScript who want to build REST APIs quickly"].
---
## Quick Start (5 Minutes)
Get up and running in under 5 minutes:
### 1. Install
```bash
# Using npm
npm install [package-name]
# Using yarn
yarn add [package-name]
# Using pip (Python)
pip install [package-name]
```
### 2. Configure
Create a configuration file or set environment variables:
```bash
# Option 1: Environment variable
export API_KEY="your-api-key"
# Option 2: Config file
echo 'API_KEY=your-api-key' > .env
```
### 3. Run
```bash
# Start the application/service
[command-to-run]
```
**Expected Output**:
```
[Show what users should see when successful]
Server running on http://localhost:3000
Ready to accept connections
```
✅ **Success!** If you see the above output, you're ready to go!
---
## Core Concepts
Before diving deeper, understand these key concepts:
### [Concept 1]
**Definition**: [Simple explanation]
**Why It Matters**: [Real-world relevance]
**Example**:
```[language]
// Simple code example demonstrating the concept
[code]
```
---
### [Concept 2]
**Definition**: [Explanation]
**Visual Representation**:
```
[ASCII diagram or simple illustration if helpful]
```
---
### [Concept 3]
**Definition**: [Explanation]
**Key Points**:
- [Important detail 1]
- [Important detail 2]
- [Important detail 3]
---
## Installation
### System Requirements
- **Operating System**: [OS requirements]
- **Runtime**: [e.g., "Node.js 18+", "Python 3.9+", "Java 17+"]
- **Memory**: [Minimum RAM]
- **Disk Space**: [Minimum space needed]
### Prerequisites
Before installing, ensure you have:
- [ ] [Prerequisite 1]
- [ ] [Prerequisite 2]
- [ ] [Prerequisite 3]
### Installation Methods
#### Method 1: Package Manager (Recommended)
```bash
# For Node.js/npm
npm install -g [package-name]
# For Python/pip
pip install [package-name]
# For macOS/Homebrew
brew install [package-name]
```
**Verify installation**:
```bash
[command] --version
```
Expected output: `[package-name] version X.Y.Z`
#### Method 2: From Source
```bash
git clone https://github.com/org/repo.git
cd repo
[build-command]
[install-command]
```
#### Method 3: Binary Download
1. Download from [releases page](https://github.com/org/repo/releases)
2. Extract archive
3. Add to PATH
---
## Configuration
### Configuration Options
**Option 1: Environment Variables**
```bash
export CONFIG_OPTION_1="value1"
export CONFIG_OPTION_2="value2"
```
**Option 2: Configuration File**
Create `config.[yml|json|toml]`:
```yaml
option1: value1
option2: value2
database:
host: localhost
port: 5432
```
**Option 3: Command-Line Flags**
```bash
[command] --option1=value1 --option2=value2
```
### Configuration Precedence
Configuration is loaded in this order (later overrides earlier):
1. Default values
2. Configuration file
3. Environment variables
4. Command-line flags
---
## Your First [Project/Application]
### Step 1: Initialize Project
```bash
[command] init my-first-project
cd my-first-project
```
**Project Structure**:
```
my-first-project/
├── src/
│ └── [main files]
├── config/
│ └── [config files]
├── [config-file]
└── README.md
```
### Step 2: Customize Configuration
Edit `[config-file]`:
```[language]
{
"name": "my-first-project",
"description": "My first [product] project",
"[key-setting]": "[value]"
}
```
### Step 3: Run the Project
```bash
[run-command]
```
**What's Happening**:
- [Explanation of what the command does]
- [What processes are starting]
- [Where to see output/results]
### Step 4: Verify It Works
Open browser to `http://localhost:[port]` or run:
```bash
curl http://localhost:[port]/[endpoint]
```
**Expected Response**:
```json
{
"status": "success",
"message": "Hello from [product]!"
}
```
---
## Common Workflows
### Workflow 1: [Common Task]
```bash
# Step 1: [Action]
[command1]
# Step 2: [Action]
[command2]
# Step 3: [Action]
[command3]
```
### Workflow 2: [Another Common Task]
```bash
[commands]
```
---
## CLI Reference (Quick Overview)
Full command reference in [link to full docs].
| Command | Description | Example |
|---------|-------------|---------|
| `[cmd] init` | Initialize new project | `[cmd] init my-app` |
| `[cmd] start` | Start application | `[cmd] start --port 3000` |
| `[cmd] build` | Build for production | `[cmd] build --env production` |
| `[cmd] test` | Run tests | `[cmd] test --coverage` |
**Get help**:
```bash
[cmd] --help # General help
[cmd] [subcommand] -h # Subcommand help
```
---
## FAQ
### General
**Q: [Common question 1]?**
A: [Answer with links to relevant docs if needed]
**Q: [Common question 2]?**
A: [Answer]
### Troubleshooting
**Q: I get "[error message]" - what does this mean?**
A: [Explanation and solution]
**Q: [Another common error]?**
A: [Solution with example]
---
## Next Steps
### Tutorials
Now that you have [product] installed and running, try these tutorials:
1. **[Tutorial 1]**: [Brief description] ([link])
2. **[Tutorial 2]**: [Brief description] ([link])
3. **[Tutorial 3]**: [Brief description] ([link])
### Documentation
- **[User Guide]**: Comprehensive feature documentation
- **[API Reference]**: Complete API documentation
- **[Examples]**: Sample projects and code snippets
- **[Best Practices]**: Production-ready patterns
### Community & Support
- **GitHub**: [Repository URL]
- **Discord/Slack**: [Community link]
- **Stack Overflow**: Tag `[product-tag]`
- **Twitter**: [@handle]
---
## Additional Resources
### Sample Projects
- [Sample project 1 with link]
- [Sample project 2 with link]
- [Sample project 3 with link]
### Video Tutorials
- [Video 1 title and link]
- [Video 2 title and link]
### Blog Posts
- [Blog post 1 with link]
- [Blog post 2 with link]
---
## Need Help?
**Support Channels**:
- 📧 Email: support@example.com
- 💬 Chat: [Link to support chat]
- 📚 Docs: [Link to full documentation]
- 🐛 Bug Reports: [Link to issue tracker]
**Before Asking for Help**:
1. Check the [FAQ](#faq)
2. Search [existing issues](link)
3. Review [troubleshooting guide](link)
---
**Welcome to [Product Name]!** 🎉
Now that you're set up, start building!
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: 471k | 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: 471k | 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: 471k | 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 |