jburlison/metaprompts/generate-agent-docs

# Agent: [Agent Name]
 
## Overview
[What this agent does and why it exists]
 
## When to Use This Agent
 
Use `@[agent-name]` when:
-[Scenario 1]
-[Scenario 2]
-[Scenario 3]
 
**Don't use** when:
-[Anti-pattern 1]
-[Anti-pattern 2]
 
## How It Behaves
 
This agent will:
-[Behavior 1]
-[Behavior 2]
-[Behavior 3]
 
## Example Conversations
 
### Example 1: [Scenario Title]
 
**You:** [Example user message]
 
**Agent:** [How agent responds - summarized]
 
### Example 2: [Scenario Title]
 
**You:** [Example user message]
 
**Agent:** [How agent responds - summarized]
 
## Tips for Best Results
 
-[Tip 1 for effective usage]
-[Tip 2 for effective usage]
-[Common mistake to avoid]
 
## Related
 
-**[Related Agent]**: Use for [distinction]
-**[Related Skill]**: This agent uses this for [purpose]

# Skill: [Skill Name]
 
## Purpose
[What this skill accomplishes]
 
## Triggers
This skill activates when:
-[Trigger keyword/scenario 1]
-[Trigger keyword/scenario 2]
 
## What It Does
[Step-by-step of what the skill does]
 
## Used By
-[Agent 1] - for [purpose]
-[Agent 2] - for [purpose]
 
## Example
 
**Scenario:** [Description]
 
**Input:** [What's provided]
 
**Output:** [What's produced]

# Prompt: [Prompt Name]
 
## Purpose
[What task this prompt accomplishes]
 
## Mode
`[mode]` - [explanation of what this mode does]
 
## Variables
 
| Variable | Description | Example |
|----------|-------------|---------|
| `{{var1}}` | [what it's for] | [example value] |
 
## How to Use
 
1.[Step 1]
2.[Step 2]
 
## Example
 
**With these values:**
-`{{var1}}` = [value]
 
**Produces:**
[Example output]

# Instructions: [Name]
 
## Applies To
Files matching: `[glob pattern]`
 
## Purpose
[What guidance these instructions provide]
 
## Key Rules
 
1.[Rule 1]
2.[Rule 2]
3.[Rule 3]
 
## When Active
These instructions automatically apply when you're working with files that match the pattern above.
 
## Examples of Affected Files
-`[example path 1]`
-`[example path 2]`

# AI Coding Assistant Customizations
 
This document catalogs all custom agents, skills, prompts, and instructions configured for this project.
 
## Provider
[Specify which provider folder is used: `.github/`, `.claude/`, `.codex/`, `.config/opencode/`]
 
## Quick Reference
 
### Agents (User-Invokable)
 
| Agent | Purpose | Invoke With |
|-------|---------|-------------|
| [name] | [brief purpose] | `@[name]` |
 
### Sub-Agents (Workflow Components)
 
| Sub-Agent | Purpose | Used By |
|-----------|---------|---------|
| [name] | [brief purpose] | [parent workflow agent] |
 
### Skills
 
| Skill | Purpose | Triggers |
|-------|---------|----------|
| [name] | [brief purpose] | [keywords] |
 
### Prompts
 
| Prompt | Mode | Purpose |
|--------|------|---------|
| [name] | [mode] | [brief purpose] |
 
### Instructions
 
| Instructions | Applies To | Purpose |
|--------------|------------|---------|
| [name] | [pattern] | [brief purpose] |
 
## Detailed Documentation
 
[Full documentation for each item]
 
## Usage Guidelines
 
[General guidance on how to use these customizations effectively]