refactor(skills): convert index-docs.xml to native skill directory (#1878)
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
parent
3339f24890
commit
6292b0323f
|
|
@ -2,7 +2,7 @@ module,phase,name,code,sequence,workflow-file,command,required,agent,options,des
|
||||||
core,anytime,Brainstorming,BSP,,_bmad/core/workflows/brainstorming/workflow.md,bmad-brainstorming,false,analyst,,"Generate diverse ideas through interactive techniques. Use early in ideation phase or when stuck generating ideas.",{output_folder}/brainstorming/brainstorming-session-{{date}}.md,,
|
core,anytime,Brainstorming,BSP,,_bmad/core/workflows/brainstorming/workflow.md,bmad-brainstorming,false,analyst,,"Generate diverse ideas through interactive techniques. Use early in ideation phase or when stuck generating ideas.",{output_folder}/brainstorming/brainstorming-session-{{date}}.md,,
|
||||||
core,anytime,Party Mode,PM,,_bmad/core/workflows/party-mode/workflow.md,bmad-party-mode,false,party-mode facilitator,,"Orchestrate multi-agent discussions. Use when you need multiple agent perspectives or want agents to collaborate.",,
|
core,anytime,Party Mode,PM,,_bmad/core/workflows/party-mode/workflow.md,bmad-party-mode,false,party-mode facilitator,,"Orchestrate multi-agent discussions. Use when you need multiple agent perspectives or want agents to collaborate.",,
|
||||||
core,anytime,bmad-help,BH,,skill:bmad-help,bmad-help,false,,,"Get unstuck by showing what workflow steps come next or answering BMad Method questions.",,
|
core,anytime,bmad-help,BH,,skill:bmad-help,bmad-help,false,,,"Get unstuck by showing what workflow steps come next or answering BMad Method questions.",,
|
||||||
core,anytime,Index Docs,ID,,_bmad/core/tasks/index-docs.xml,bmad-index-docs,false,,,"Create lightweight index for quick LLM scanning. Use when LLM needs to understand available docs without loading everything.",,
|
core,anytime,Index Docs,ID,,skill:bmad-index-docs,bmad-index-docs,false,,,"Create lightweight index for quick LLM scanning. Use when LLM needs to understand available docs without loading everything.",,
|
||||||
core,anytime,Shard Document,SD,,_bmad/core/tasks/shard-doc.xml,bmad-shard-doc,false,,,"Split large documents into smaller files by sections. Use when doc becomes too large (>500 lines) to manage effectively.",,
|
core,anytime,Shard Document,SD,,_bmad/core/tasks/shard-doc.xml,bmad-shard-doc,false,,,"Split large documents into smaller files by sections. Use when doc becomes too large (>500 lines) to manage effectively.",,
|
||||||
core,anytime,Editorial Review - Prose,EP,,skill:bmad-editorial-review-prose,bmad-editorial-review-prose,false,,,"Review prose for clarity, tone, and communication issues. Use after drafting to polish written content.",report located with target document,"three-column markdown table with suggested fixes",
|
core,anytime,Editorial Review - Prose,EP,,skill:bmad-editorial-review-prose,bmad-editorial-review-prose,false,,,"Review prose for clarity, tone, and communication issues. Use after drafting to polish written content.",report located with target document,"three-column markdown table with suggested fixes",
|
||||||
core,anytime,Editorial Review - Structure,ES,,skill:bmad-editorial-review-structure,bmad-editorial-review-structure,false,,,"Propose cuts, reorganization, and simplification while preserving comprehension. Use when doc produced from multiple subprocesses or needs structural improvement.",report located with target document,
|
core,anytime,Editorial Review - Structure,ES,,skill:bmad-editorial-review-structure,bmad-editorial-review-structure,false,,,"Propose cuts, reorganization, and simplification while preserving comprehension. Use when doc produced from multiple subprocesses or needs structural improvement.",report located with target document,
|
||||||
|
|
|
||||||
|
Can't render this file because it has a wrong number of fields in line 2.
|
|
|
@ -0,0 +1,6 @@
|
||||||
|
---
|
||||||
|
name: bmad-index-docs
|
||||||
|
description: 'Generates or updates an index.md to reference all docs in the folder. Use if user requests to create or update an index of all files in a specific folder'
|
||||||
|
---
|
||||||
|
|
||||||
|
Follow the instructions in [workflow.md](workflow.md).
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
type: skill
|
||||||
|
|
@ -0,0 +1,61 @@
|
||||||
|
# Index Docs
|
||||||
|
|
||||||
|
**Goal:** Generate or update an index.md to reference all docs in a target folder.
|
||||||
|
|
||||||
|
|
||||||
|
## EXECUTION
|
||||||
|
|
||||||
|
### Step 1: Scan Directory
|
||||||
|
|
||||||
|
- List all files and subdirectories in the target location
|
||||||
|
|
||||||
|
### Step 2: Group Content
|
||||||
|
|
||||||
|
- Organize files by type, purpose, or subdirectory
|
||||||
|
|
||||||
|
### Step 3: Generate Descriptions
|
||||||
|
|
||||||
|
- Read each file to understand its actual purpose and create brief (3-10 word) descriptions based on the content, not just the filename
|
||||||
|
|
||||||
|
### Step 4: Create/Update Index
|
||||||
|
|
||||||
|
- Write or update index.md with organized file listings
|
||||||
|
|
||||||
|
|
||||||
|
## OUTPUT FORMAT
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
# Directory Index
|
||||||
|
|
||||||
|
## Files
|
||||||
|
|
||||||
|
- **[filename.ext](./filename.ext)** - Brief description
|
||||||
|
- **[another-file.ext](./another-file.ext)** - Brief description
|
||||||
|
|
||||||
|
## Subdirectories
|
||||||
|
|
||||||
|
### subfolder/
|
||||||
|
|
||||||
|
- **[file1.ext](./subfolder/file1.ext)** - Brief description
|
||||||
|
- **[file2.ext](./subfolder/file2.ext)** - Brief description
|
||||||
|
|
||||||
|
### another-folder/
|
||||||
|
|
||||||
|
- **[file3.ext](./another-folder/file3.ext)** - Brief description
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## HALT CONDITIONS
|
||||||
|
|
||||||
|
- HALT if target directory does not exist or is inaccessible
|
||||||
|
- HALT if user does not have write permissions to create index.md
|
||||||
|
|
||||||
|
|
||||||
|
## VALIDATION
|
||||||
|
|
||||||
|
- Use relative paths starting with ./
|
||||||
|
- Group similar files together
|
||||||
|
- Read file contents to generate accurate descriptions - don't guess from filenames
|
||||||
|
- Keep descriptions concise but informative (3-10 words)
|
||||||
|
- Sort alphabetically within groups
|
||||||
|
- Skip hidden files (starting with .) unless specified
|
||||||
|
|
@ -1,8 +1,3 @@
|
||||||
index-docs.xml:
|
|
||||||
canonicalId: bmad-index-docs
|
|
||||||
type: task
|
|
||||||
description: "Generates or updates an index.md to reference all docs in the folder"
|
|
||||||
|
|
||||||
shard-doc.xml:
|
shard-doc.xml:
|
||||||
canonicalId: bmad-shard-doc
|
canonicalId: bmad-shard-doc
|
||||||
type: task
|
type: task
|
||||||
|
|
|
||||||
|
|
@ -1,65 +0,0 @@
|
||||||
<task id="_bmad/core/tasks/index-docs" name="Index Docs"
|
|
||||||
description="Generates or updates an index.md to reference all docs in the folder. Use if user requests to create or update an index of all files in a specific folder">
|
|
||||||
<llm critical="true">
|
|
||||||
<i>MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER</i>
|
|
||||||
<i>DO NOT skip steps or change the sequence</i>
|
|
||||||
<i>HALT immediately when halt-conditions are met</i>
|
|
||||||
<i>Each action xml tag within step xml tag is a REQUIRED action to complete that step</i>
|
|
||||||
<i>Sections outside flow (validation, output, critical-context) provide essential context - review and apply throughout execution</i>
|
|
||||||
</llm>
|
|
||||||
|
|
||||||
<flow>
|
|
||||||
<step n="1" title="Scan Directory">
|
|
||||||
<i>List all files and subdirectories in the target location</i>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="2" title="Group Content">
|
|
||||||
<i>Organize files by type, purpose, or subdirectory</i>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="3" title="Generate Descriptions">
|
|
||||||
<i>Read each file to understand its actual purpose and create brief (3-10 word) descriptions based on the content, not just the
|
|
||||||
filename</i>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="4" title="Create/Update Index">
|
|
||||||
<i>Write or update index.md with organized file listings</i>
|
|
||||||
</step>
|
|
||||||
</flow>
|
|
||||||
|
|
||||||
<output-format>
|
|
||||||
<example>
|
|
||||||
# Directory Index
|
|
||||||
|
|
||||||
## Files
|
|
||||||
|
|
||||||
- **[filename.ext](./filename.ext)** - Brief description
|
|
||||||
- **[another-file.ext](./another-file.ext)** - Brief description
|
|
||||||
|
|
||||||
## Subdirectories
|
|
||||||
|
|
||||||
### subfolder/
|
|
||||||
|
|
||||||
- **[file1.ext](./subfolder/file1.ext)** - Brief description
|
|
||||||
- **[file2.ext](./subfolder/file2.ext)** - Brief description
|
|
||||||
|
|
||||||
### another-folder/
|
|
||||||
|
|
||||||
- **[file3.ext](./another-folder/file3.ext)** - Brief description
|
|
||||||
</example>
|
|
||||||
</output-format>
|
|
||||||
|
|
||||||
<halt-conditions critical="true">
|
|
||||||
<i>HALT if target directory does not exist or is inaccessible</i>
|
|
||||||
<i>HALT if user does not have write permissions to create index.md</i>
|
|
||||||
</halt-conditions>
|
|
||||||
|
|
||||||
<validation>
|
|
||||||
<i>Use relative paths starting with ./</i>
|
|
||||||
<i>Group similar files together</i>
|
|
||||||
<i>Read file contents to generate accurate descriptions - don't guess from filenames</i>
|
|
||||||
<i>Keep descriptions concise but informative (3-10 words)</i>
|
|
||||||
<i>Sort alphabetically within groups</i>
|
|
||||||
<i>Skip hidden files (starting with .) unless specified</i>
|
|
||||||
</validation>
|
|
||||||
</task>
|
|
||||||
Loading…
Reference in New Issue