- Extract troubleshooting guide to TROUBLESHOOTING.md - Move usage examples to USAGE_EXAMPLES.md for better discoverability - Add custom specialty creation guide to CONTRIBUTIONS.md - Create semantic commit message generator prompt in prompts/ - Streamline README.md by removing 200+ lines of content now in dedicated files - Improve documentation navigation with clearer separation of concerns
68 lines
1.9 KiB
Markdown
68 lines
1.9 KiB
Markdown
# 💡 Usage Examples
|
|
|
|
## Example 1: Creating a Technical Document
|
|
|
|
```plaintext
|
|
User: "I need to create API documentation for our REST service"
|
|
|
|
Frank (Core): "I'll guide you through creating comprehensive API documentation.
|
|
Let me use the Technical Writer persona and Documentation workflow..."
|
|
|
|
[Walks through structure, audience, content gathering, drafting]
|
|
```
|
|
|
|
## Example 2: DevOps Troubleshooting
|
|
|
|
```plaintext
|
|
User: "My Docker Compose stack won't start, getting network errors"
|
|
|
|
Frank (Core + DevOps): "I'll help diagnose this. Triggering DevOps SRE persona.
|
|
Let me gather diagnostics..."
|
|
|
|
[Requests specific outputs, analyzes logs, proposes minimal fix with verification steps]
|
|
```
|
|
|
|
## Example 3: Data Analysis with Reasoning
|
|
|
|
```plaintext
|
|
User: "Analyze Q1 sales data and identify trends"
|
|
|
|
Frank (Core + Data Analysis + CoT): "I'll analyze this using Structured Chain-of-Thought.
|
|
|
|
## 1. Clarify & Define
|
|
Your objective: Identify sales trends in Q1 data
|
|
Key sources: sales table, customers table
|
|
Success criteria: Actionable insights with visualizations
|
|
|
|
## 2. Repository Check
|
|
[Reviews existing scripts]
|
|
|
|
## 3. Plan & Methodology
|
|
[Outlines analytical steps]
|
|
..."
|
|
```
|
|
|
|
## Example 4: Root Cause Analysis with ITIL
|
|
|
|
```plaintext
|
|
User: "Email server has been slow all week, need to find root cause"
|
|
|
|
Frank (Core + ITIL): "I'll conduct a root cause analysis using ITIL Problem Management.
|
|
Triggering Problem Manager persona with Tree-of-Thought analysis..."
|
|
|
|
[Gathers timeline, generates hypotheses, evaluates evidence, documents RCA]
|
|
```
|
|
|
|
## Example 5: Multi-Specialty Composition
|
|
|
|
```plaintext
|
|
Load: Core + DevOps + Data Analysis
|
|
|
|
User: "Help me analyze Docker container metrics and visualize resource usage"
|
|
|
|
Frank: "This combines my DevOps and Data Analysis expertise.
|
|
I'll use Docker diagnostic commands to gather metrics, then Python/Pandas for analysis..."
|
|
|
|
[Bridges both domains seamlessly]
|
|
```
|