generate-agent-docs

Name: generate-agent-docs
Author: JBurlison

70stars8forks

How to install generate-agent-docs?

jburlison/metaprompts/generate-agent-docs

$npx -y skills add JBurlison/MetaPrompts --skill generate-agent-docs

Installs into the current project.

Summary

Generates documentation and usage guides for agents, skills, prompts, and instructions. Works with GitHub Copilot, Claude Code, Codex, OpenCode, and other providers. Use when onboarding team members, creating README files for your customizations, or generating usage examples for

Files · 1

View on GitHub

SKILL.md

1	# Generate Agent Documentation
2
3	Creates user-friendly documentation for AI coding assistant customization files.
4
5	## Provider Folder Reference
6
7	This skill works across multiple AI coding assistant providers:
8
9	\| Provider \| Base Folder \|
10	\|----------\|-------------\|
11	\| GitHub Copilot \| `.github/` \|
12	\| Claude Code \| `.claude/` \|
13	\| Codex \| `.codex/` \|
14	\| OpenCode \| `.config/opencode/` \|
15
16	Throughout this document, `<provider>/` represents your chosen provider's base folder.
17
18	## When to Use
19
20	- Onboarding new team members to your agent ecosystem
21	- Creating a catalog of available agents and skills
22	- Generating usage examples for specific agents
23	- Documenting your customization setup for reference
24
25	## Documentation Types
26
27	### Individual Item Documentation
28
29	Generate detailed docs for a single agent, skill, prompt, or instruction.
30
31	### Catalog Documentation
32
33	Generate a comprehensive overview of all customization files.
34
35	## Output Templates
36
37	### Agent Documentation
38
39	```markdown
40	# Agent: [Agent Name]
41
42	## Overview
43	[What this agent does and why it exists]
44
45	## When to Use This Agent
46
47	Use `@[agent-name]` when:
48	- [Scenario 1]
49	- [Scenario 2]
50	- [Scenario 3]
51
52	Don't use when:
53	- [Anti-pattern 1]
54	- [Anti-pattern 2]
55
56	## How It Behaves
57
58	This agent will:
59	- [Behavior 1]
60	- [Behavior 2]
61	- [Behavior 3]
62
63	## Example Conversations
64
65	### Example 1: [Scenario Title]
66
67	You: [Example user message]
68
69	Agent: [How agent responds - summarized]
70
71	### Example 2: [Scenario Title]
72
73	You: [Example user message]
74
75	Agent: [How agent responds - summarized]
76
77	## Tips for Best Results
78
79	- [Tip 1 for effective usage]
80	- [Tip 2 for effective usage]
81	- [Common mistake to avoid]
82
83	## Related
84
85	- [Related Agent]: Use for [distinction]
86	- [Related Skill]: This agent uses this for [purpose]
87	```
88
89	### Skill Documentation
90
91	```markdown
92	# Skill: [Skill Name]
93
94	## Purpose
95	[What this skill accomplishes]
96
97	## Triggers
98	This skill activates when:
99	- [Trigger keyword/scenario 1]
100	- [Trigger keyword/scenario 2]
101
102	## What It Does
103	[Step-by-step of what the skill does]
104
105	## Used By
106	- [Agent 1] - for [purpose]
107	- [Agent 2] - for [purpose]
108
109	## Example
110
111	Scenario: [Description]
112
113	Input: [What's provided]
114
115	Output: [What's produced]
116	```
117
118	### Prompt Documentation
119
120	```markdown
121	# Prompt: [Prompt Name]
122
123	## Purpose
124	[What task this prompt accomplishes]
125
126	## Mode
127	`[mode]` - [explanation of what this mode does]
128
129	## Variables
130
131	\| Variable \| Description \| Example \|
132	\|----------\|-------------\|---------\|
133	\| `{{var1}}` \| [what it's for] \| [example value] \|
134
135	## How to Use
136
137	1. [Step 1]
138	2. [Step 2]
139
140	## Example
141
142	With these values:
143	- `{{var1}}` = [value]
144
145	Produces:
146	[Example output]
147	```
148
149	### Instruction Documentation
150
151	```markdown
152	# Instructions: [Name]
153
154	## Applies To
155	Files matching: `[glob pattern]`
156
157	## Purpose
158	[What guidance these instructions provide]
159
160	## Key Rules
161
162	1. [Rule 1]
163	2. [Rule 2]
164	3. [Rule 3]
165
166	## When Active
167	These instructions automatically apply when you're working with files that match the pattern above.
168
169	## Examples of Affected Files
170	- `[example path 1]`
171	- `[example path 2]`
172	```
173
174	### Catalog Documentation
175
176	```markdown
177	# AI Coding Assistant Customizations
178
179	This document catalogs all custom agents, skills, prompts, and instructions configured for this project.
180
181	## Provider
182	[Specify which provider folder is used: `.github/`, `.claude/`, `.codex/`, `.config/opencode/`]
183
184	## Quick Reference
185
186	### Agents (User-Invokable)
187
188	\| Agent \| Purpose \| Invoke With \|
189	\|-------\|---------\|-------------\|
190	\| [name] \| [brief purpose] \| `@[name]` \|
191
192	### Sub-Agents (Workflow Components)
193
194	\| Sub-Agent \| Purpose \| Used By \|
195	\|-----------\|---------\|---------\|
196	\| [name] \| [brief purpose] \| [parent workflow agent] \|
197
198	### Skills
199
200	\| Skill \| Purpose \| Triggers \|
201	\|-------\|---------\|----------\|
202	\| [name] \| [brief purpose] \| [keywords] \|
203
204	### Prompts
205
206	\| Prompt \| Mode \| Purpose \|
207	\|--------\|------\|---------\|
208	\| [name] \| [mode] \| [brief purpose] \|
209
210	### Instructions
211
212	\| Instructions \| Applies To \| Purpose \|
213	\|--------------\|------------\|---------\|
214	\| [name] \| [pattern] \| [brief purpose] \|
215
216	## Detailed Documentation
217
218	[Full documentation for each item]
219
220	## Usage Guidelines
221
222	[General guidance on how to use these customizations effectively]
223	```
224
225	## Generation Process
226
227	### Step 1: Read Source File
228	Load the agent/skill/prompt/instruction file.
229
230	### Step 2: Extract Key Information
231	- Name and description from frontmatter
232	- Behaviors and rules from body
233	- Examples if present
234	- Related items (skills, handoffs)
235
236	### Step 3: Enhance with Context
237	- Generate additional examples based on purpose
238	- Identify related items from the ecosystem
239	- Add tips based on common patterns
240
241	### Step 4: Format Ou

People who liked this also viewed

6 picks

Type

generate-agent-docs

70stars8forks

View on GitHub

How to install generate-agent-docs?

jburlison/metaprompts/generate-agent-docs

$npx -y skills add JBurlison/MetaPrompts --skill generate-agent-docs

Installs into the current project.

Summary

Files · 1

View on GitHub

SKILL.md

1	# Generate Agent Documentation
2
3	Creates user-friendly documentation for AI coding assistant customization files.
4
5	## Provider Folder Reference
6
7	This skill works across multiple AI coding assistant providers:
8
9	\| Provider \| Base Folder \|
10	\|----------\|-------------\|
11	\| GitHub Copilot \| `.github/` \|
12	\| Claude Code \| `.claude/` \|
13	\| Codex \| `.codex/` \|
14	\| OpenCode \| `.config/opencode/` \|
15
16	Throughout this document, `<provider>/` represents your chosen provider's base folder.
17
18	## When to Use
19
20	- Onboarding new team members to your agent ecosystem
21	- Creating a catalog of available agents and skills
22	- Generating usage examples for specific agents
23	- Documenting your customization setup for reference
24
25	## Documentation Types
26
27	### Individual Item Documentation
28
29	Generate detailed docs for a single agent, skill, prompt, or instruction.
30
31	### Catalog Documentation
32
33	Generate a comprehensive overview of all customization files.
34
35	## Output Templates
36
37	### Agent Documentation
38
39	```markdown
40	# Agent: [Agent Name]
41
42	## Overview
43	[What this agent does and why it exists]
44
45	## When to Use This Agent
46
47	Use `@[agent-name]` when:
48	- [Scenario 1]
49	- [Scenario 2]
50	- [Scenario 3]
51
52	Don't use when:
53	- [Anti-pattern 1]
54	- [Anti-pattern 2]
55
56	## How It Behaves
57
58	This agent will:
59	- [Behavior 1]
60	- [Behavior 2]
61	- [Behavior 3]
62
63	## Example Conversations
64
65	### Example 1: [Scenario Title]
66
67	You: [Example user message]
68
69	Agent: [How agent responds - summarized]
70
71	### Example 2: [Scenario Title]
72
73	You: [Example user message]
74
75	Agent: [How agent responds - summarized]
76
77	## Tips for Best Results
78
79	- [Tip 1 for effective usage]
80	- [Tip 2 for effective usage]
81	- [Common mistake to avoid]
82
83	## Related
84
85	- [Related Agent]: Use for [distinction]
86	- [Related Skill]: This agent uses this for [purpose]
87	```
88
89	### Skill Documentation
90
91	```markdown
92	# Skill: [Skill Name]
93
94	## Purpose
95	[What this skill accomplishes]
96
97	## Triggers
98	This skill activates when:
99	- [Trigger keyword/scenario 1]
100	- [Trigger keyword/scenario 2]
101
102	## What It Does
103	[Step-by-step of what the skill does]
104
105	## Used By
106	- [Agent 1] - for [purpose]
107	- [Agent 2] - for [purpose]
108
109	## Example
110
111	Scenario: [Description]
112
113	Input: [What's provided]
114
115	Output: [What's produced]
116	```
117
118	### Prompt Documentation
119
120	```markdown
121	# Prompt: [Prompt Name]
122
123	## Purpose
124	[What task this prompt accomplishes]
125
126	## Mode
127	`[mode]` - [explanation of what this mode does]
128
129	## Variables
130
131	\| Variable \| Description \| Example \|
132	\|----------\|-------------\|---------\|
133	\| `{{var1}}` \| [what it's for] \| [example value] \|
134
135	## How to Use
136
137	1. [Step 1]
138	2. [Step 2]
139
140	## Example
141
142	With these values:
143	- `{{var1}}` = [value]
144
145	Produces:
146	[Example output]
147	```
148
149	### Instruction Documentation
150
151	```markdown
152	# Instructions: [Name]
153
154	## Applies To
155	Files matching: `[glob pattern]`
156
157	## Purpose
158	[What guidance these instructions provide]
159
160	## Key Rules
161
162	1. [Rule 1]
163	2. [Rule 2]
164	3. [Rule 3]
165
166	## When Active
167	These instructions automatically apply when you're working with files that match the pattern above.
168
169	## Examples of Affected Files
170	- `[example path 1]`
171	- `[example path 2]`
172	```
173
174	### Catalog Documentation
175
176	```markdown
177	# AI Coding Assistant Customizations
178
179	This document catalogs all custom agents, skills, prompts, and instructions configured for this project.
180
181	## Provider
182	[Specify which provider folder is used: `.github/`, `.claude/`, `.codex/`, `.config/opencode/`]
183
184	## Quick Reference
185
186	### Agents (User-Invokable)
187
188	\| Agent \| Purpose \| Invoke With \|
189	\|-------\|---------\|-------------\|
190	\| [name] \| [brief purpose] \| `@[name]` \|
191
192	### Sub-Agents (Workflow Components)
193
194	\| Sub-Agent \| Purpose \| Used By \|
195	\|-----------\|---------\|---------\|
196	\| [name] \| [brief purpose] \| [parent workflow agent] \|
197
198	### Skills
199
200	\| Skill \| Purpose \| Triggers \|
201	\|-------\|---------\|----------\|
202	\| [name] \| [brief purpose] \| [keywords] \|
203
204	### Prompts
205
206	\| Prompt \| Mode \| Purpose \|
207	\|--------\|------\|---------\|
208	\| [name] \| [mode] \| [brief purpose] \|
209
210	### Instructions
211
212	\| Instructions \| Applies To \| Purpose \|
213	\|--------------\|------------\|---------\|
214	\| [name] \| [pattern] \| [brief purpose] \|
215
216	## Detailed Documentation
217
218	[Full documentation for each item]
219
220	## Usage Guidelines
221
222	[General guidance on how to use these customizations effectively]
223	```
224
225	## Generation Process
226
227	### Step 1: Read Source File
228	Load the agent/skill/prompt/instruction file.
229
230	### Step 2: Extract Key Information
231	- Name and description from frontmatter
232	- Behaviors and rules from body
233	- Examples if present
234	- Related items (skills, handoffs)
235
236	### Step 3: Enhance with Context
237	- Generate additional examples based on purpose
238	- Identify related items from the ecosystem
239	- Add tips based on common patterns
240
241	### Step 4: Format Ou

People who liked this also viewed

6 picks

Type