x-ipe 1.0.23__py3-none-any.whl β 1.0.25__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- x_ipe/app.py +32 -1
- x_ipe/handlers/terminal_handlers.py +6 -0
- x_ipe/handlers/voice_handlers.py +5 -0
- x_ipe/resources/copilot-instructions.md +19 -6
- x_ipe/resources/skills/lesson-learned/SKILL.md +208 -0
- x_ipe/resources/skills/lesson-learned/references/examples.md +238 -0
- x_ipe/resources/skills/project-quality-board-management/SKILL.md +135 -298
- x_ipe/resources/skills/project-quality-board-management/references/evaluation-principles.md +213 -0
- x_ipe/resources/skills/project-quality-board-management/references/evaluation-procedures.md +214 -0
- x_ipe/resources/skills/project-quality-board-management/templates/quality-report.md +70 -18
- x_ipe/resources/skills/task-execution-guideline/SKILL.md +2 -2
- x_ipe/resources/skills/task-execution-guideline/templates/task-record.yaml +1 -1
- x_ipe/resources/skills/task-type-code-implementation/SKILL.md +72 -270
- x_ipe/resources/skills/task-type-code-implementation/references/implementation-guidelines.md +432 -0
- x_ipe/resources/skills/task-type-code-refactor-v2/SKILL.md +127 -353
- x_ipe/resources/skills/task-type-code-refactor-v2/references/refactoring-techniques.md +373 -0
- x_ipe/resources/skills/task-type-feature-breakdown/SKILL.md +31 -243
- x_ipe/resources/skills/task-type-feature-breakdown/references/breakdown-guidelines.md +330 -0
- x_ipe/resources/skills/task-type-feature-refinement/SKILL.md +27 -180
- x_ipe/resources/skills/task-type-feature-refinement/references/specification-writing-guide.md +267 -0
- x_ipe/resources/skills/task-type-idea-mockup/SKILL.md +38 -276
- x_ipe/resources/skills/task-type-idea-mockup/references/mockup-guidelines.md +299 -0
- x_ipe/resources/skills/task-type-idea-to-architecture/SKILL.md +20 -218
- x_ipe/resources/skills/task-type-idea-to-architecture/references/architecture-patterns.md +342 -0
- x_ipe/resources/skills/task-type-ideation/SKILL.md +10 -266
- x_ipe/resources/skills/task-type-ideation/references/folder-naming-guide.md +55 -0
- x_ipe/resources/skills/task-type-ideation/references/tool-usage-guide.md +236 -0
- x_ipe/resources/skills/task-type-ideation-v2/SKILL.md +488 -0
- x_ipe/resources/skills/task-type-ideation-v2/references/examples.md +377 -0
- x_ipe/resources/skills/task-type-ideation-v2/references/folder-naming-guide.md +74 -0
- x_ipe/resources/skills/task-type-ideation-v2/references/tool-usage-guide.md +145 -0
- x_ipe/resources/skills/task-type-ideation-v2/references/visualization-guide.md +160 -0
- x_ipe/resources/skills/task-type-ideation-v2/templates/idea-summary.md +86 -0
- x_ipe/resources/skills/task-type-refactoring-analysis/SKILL.md +83 -145
- x_ipe/resources/skills/task-type-refactoring-analysis/references/output-schema.md +172 -0
- x_ipe/resources/skills/task-type-technical-design/SKILL.md +28 -214
- x_ipe/resources/skills/task-type-technical-design/references/design-templates.md +422 -0
- x_ipe/resources/skills/task-type-test-generation/SKILL.md +47 -332
- x_ipe/resources/skills/task-type-test-generation/references/test-patterns.md +368 -0
- x_ipe/resources/skills/tool-tracing-creator/SKILL.md +312 -0
- x_ipe/resources/skills/tool-tracing-creator/references/examples.md +324 -0
- x_ipe/resources/skills/tool-tracing-instrumentation/SKILL.md +373 -0
- x_ipe/resources/skills/tool-tracing-instrumentation/references/examples.md +264 -0
- x_ipe/resources/skills/x-ipe-skill-creator-v3/SKILL.md +486 -0
- x_ipe/resources/skills/x-ipe-skill-creator-v3/references/10. example-gate-conditions.md +73 -0
- x_ipe/resources/skills/x-ipe-skill-creator-v3/references/11. reference-quality-standards.md +127 -0
- x_ipe/resources/skills/x-ipe-skill-creator-v3/references/2. reference-section-order.md +127 -0
- x_ipe/resources/skills/x-ipe-skill-creator-v3/references/3. example-step-based-code-review.md +84 -0
- x_ipe/resources/skills/x-ipe-skill-creator-v3/references/4. example-step-based-feature-implementation.md +113 -0
- x_ipe/resources/skills/x-ipe-skill-creator-v3/references/5. example-function-based-validation.md +73 -0
- x_ipe/resources/skills/x-ipe-skill-creator-v3/references/6. example-function-based-analysis.md +94 -0
- x_ipe/resources/skills/x-ipe-skill-creator-v3/references/7. example-task-io-code-implementation.md +36 -0
- x_ipe/resources/skills/x-ipe-skill-creator-v3/references/8. example-structured-summary.md +43 -0
- x_ipe/resources/skills/x-ipe-skill-creator-v3/references/9. example-dor-dod.md +77 -0
- x_ipe/resources/skills/x-ipe-skill-creator-v3/references/examples.md +429 -0
- x_ipe/resources/skills/x-ipe-skill-creator-v3/references/skill-general-guidelines-v2.md +611 -0
- x_ipe/resources/skills/x-ipe-skill-creator-v3/templates/skill-meta-x-ipe-meta.md +153 -0
- x_ipe/resources/skills/x-ipe-skill-creator-v3/templates/skill-meta-x-ipe-task-based.md +324 -0
- x_ipe/resources/skills/x-ipe-skill-creator-v3/templates/skill-meta-x-ipe-task-category.md +109 -0
- x_ipe/resources/skills/x-ipe-skill-creator-v3/templates/skill-meta-x-ipe-tool.md +205 -0
- x_ipe/resources/skills/x-ipe-skill-creator-v3/templates/x-ipe-meta.md +334 -0
- x_ipe/resources/skills/x-ipe-skill-creator-v3/templates/x-ipe-task-based.md +279 -0
- x_ipe/resources/skills/x-ipe-skill-creator-v3/templates/x-ipe-tool.md +175 -0
- x_ipe/resources/skills/x-ipe-skill-creator-v3/templates/x-ipe-workflow-orchestration.md +329 -0
- x_ipe/resources/skills/x-ipe-task-based-ideation/SKILL.md +487 -0
- x_ipe/resources/skills/x-ipe-task-based-ideation/references/examples.md +377 -0
- x_ipe/resources/skills/x-ipe-task-based-ideation/references/folder-naming-guide.md +74 -0
- x_ipe/resources/skills/x-ipe-task-based-ideation/references/tool-usage-guide.md +145 -0
- x_ipe/resources/skills/x-ipe-task-based-ideation/references/visualization-guide.md +160 -0
- x_ipe/resources/skills/x-ipe-task-based-ideation/templates/idea-summary.md +86 -0
- x_ipe/routes/__init__.py +2 -0
- x_ipe/routes/ideas_routes.py +289 -0
- x_ipe/routes/kb_routes.py +80 -0
- x_ipe/routes/main_routes.py +18 -0
- x_ipe/routes/project_routes.py +7 -0
- x_ipe/routes/proxy_routes.py +10 -2
- x_ipe/routes/quality_evaluation_routes.py +193 -0
- x_ipe/routes/settings_routes.py +6 -0
- x_ipe/routes/tools_routes.py +6 -0
- x_ipe/routes/tracing_routes.py +232 -0
- x_ipe/routes/uiux_feedback_routes.py +50 -0
- x_ipe/services/__init__.py +5 -0
- x_ipe/services/config_service.py +6 -0
- x_ipe/services/file_service.py +20 -0
- x_ipe/services/homepage_service.py +160 -0
- x_ipe/services/ideas_service.py +535 -2
- x_ipe/services/kb_service.py +378 -0
- x_ipe/services/proxy_service.py +37 -7
- x_ipe/services/settings_service.py +13 -0
- x_ipe/services/skills_service.py +4 -0
- x_ipe/services/terminal_service.py +24 -0
- x_ipe/services/themes_service.py +4 -0
- x_ipe/services/tools_config_service.py +4 -0
- x_ipe/services/tracing_service.py +333 -0
- x_ipe/services/uiux_feedback_service.py +148 -1
- x_ipe/services/voice_input_service_v2.py +11 -0
- x_ipe/static/css/base.css +7 -0
- x_ipe/static/css/homepage-infinity.css +330 -0
- x_ipe/static/css/kb-core.css +301 -0
- x_ipe/static/css/quality-evaluation.css +345 -0
- x_ipe/static/css/sidebar.css +14 -4
- x_ipe/static/css/terminal.css +23 -0
- x_ipe/static/css/tracing-dashboard.css +796 -0
- x_ipe/static/css/uiux-feedback.css +7 -1
- x_ipe/static/css/workplace.css +636 -0
- x_ipe/static/img/homepage-infinity-loop.png +0 -0
- x_ipe/static/js/features/confirm-dialog.js +169 -0
- x_ipe/static/js/features/folder-view.js +742 -0
- x_ipe/static/js/features/homepage-infinity.js +314 -0
- x_ipe/static/js/features/kb-core.js +371 -0
- x_ipe/static/js/features/quality-evaluation.js +387 -0
- x_ipe/static/js/features/sidebar.js +255 -12
- x_ipe/static/js/features/tracing-dashboard.js +855 -0
- x_ipe/static/js/features/tracing-graph.js +1031 -0
- x_ipe/static/js/features/tree-drag.js +227 -0
- x_ipe/static/js/features/tree-search.js +228 -0
- x_ipe/static/js/features/workplace.js +661 -33
- x_ipe/static/js/init.js +76 -0
- x_ipe/static/js/terminal-v2.js +45 -14
- x_ipe/static/js/terminal.js +50 -49
- x_ipe/static/js/uiux-feedback.js +75 -16
- x_ipe/templates/base.html +24 -0
- x_ipe/templates/index.html +10 -1
- x_ipe/templates/knowledge-base.html +110 -0
- x_ipe/templates/workplace.html +4 -0
- x_ipe/tracing/__init__.py +37 -0
- x_ipe/tracing/buffer.py +135 -0
- x_ipe/tracing/context.py +125 -0
- x_ipe/tracing/decorator.py +288 -0
- x_ipe/tracing/middleware.py +197 -0
- x_ipe/tracing/parser.py +235 -0
- x_ipe/tracing/redactor.py +111 -0
- x_ipe/tracing/writer.py +122 -0
- {x_ipe-1.0.23.dist-info β x_ipe-1.0.25.dist-info}/METADATA +2 -2
- {x_ipe-1.0.23.dist-info β x_ipe-1.0.25.dist-info}/RECORD +138 -65
- x_ipe/app.py.bak +0 -1333
- x_ipe/resources/skills/x-ipe-skill-creator/SKILL.md +0 -329
- x_ipe/resources/skills/x-ipe-skill-creator/references/output-patterns.md +0 -169
- x_ipe/resources/skills/x-ipe-skill-creator/references/skill-structure.md +0 -162
- x_ipe/resources/skills/x-ipe-skill-creator/references/workflows.md +0 -110
- x_ipe/resources/skills/x-ipe-skill-creator/templates/references/examples.md +0 -113
- x_ipe/resources/skills/x-ipe-skill-creator/templates/skill-category-skill.md +0 -296
- x_ipe/resources/skills/x-ipe-skill-creator/templates/task-type-skill.md +0 -269
- {x_ipe-1.0.23.dist-info β x_ipe-1.0.25.dist-info}/WHEEL +0 -0
- {x_ipe-1.0.23.dist-info β x_ipe-1.0.25.dist-info}/entry_points.txt +0 -0
- {x_ipe-1.0.23.dist-info β x_ipe-1.0.25.dist-info}/licenses/LICENSE +0 -0
|
@@ -0,0 +1,486 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: x-ipe-meta-skill-creator
|
|
3
|
+
description: Guide for creating effective X-IPE skills with templates, testing, and validation. Use when creating a new skill or updating an existing skill for the X-IPE framework. Triggers on requests like "create skill", "new skill", "add task type skill", "update skill".
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# X-IPE Skill Creator
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
|
|
10
|
+
Guide for creating effective X-IPE skills by:
|
|
11
|
+
1. Identifying skill type and selecting appropriate template
|
|
12
|
+
2. Gathering concrete usage examples
|
|
13
|
+
3. Creating skill with sub-agent DAG workflow
|
|
14
|
+
4. Validating against acceptance criteria
|
|
15
|
+
5. Merging to production or iterating on failures
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## About X-IPE Skills
|
|
20
|
+
|
|
21
|
+
Skills are modular, self-contained packages that extend AI Agent capabilities by providing specialized knowledge, workflows, and tools.
|
|
22
|
+
|
|
23
|
+
### What Skills Provide
|
|
24
|
+
|
|
25
|
+
1. **Specialized workflows** - Multi-step procedures for specific domains
|
|
26
|
+
2. **Tool integrations** - Instructions for working with specific file formats or APIs
|
|
27
|
+
3. **Domain expertise** - Project-specific knowledge, schemas, business logic
|
|
28
|
+
4. **Bundled resources** - Templates, references, and scripts for complex tasks
|
|
29
|
+
|
|
30
|
+
### Skill Types
|
|
31
|
+
|
|
32
|
+
| Type | Purpose | Naming Convention | SKILL.md Template | skill-meta.md Template |
|
|
33
|
+
|------|---------|-------------------|-------------------|------------------------|
|
|
34
|
+
| x-ipe-task-based | Belong to end-to-end project lifecycle workflows | `x-ipe-task-based-{name}` | [x-ipe-task-based.md](templates/x-ipe-task-based.md) | [skill-meta-x-ipe-task-based.md](templates/skill-meta-x-ipe-task-based.md) |
|
|
35
|
+
| x-ipe-task-category | Category orchestration when related tasks complete | `x-ipe-{category}-{operation}` | [x-ipe-workflow-orchestration.md](templates/x-ipe-workflow-orchestration.md) | [skill-meta-x-ipe-task-category.md](templates/skill-meta-x-ipe-task-category.md) |
|
|
36
|
+
| x-ipe-tool | Utility functions and tool integrations | `x-ipe-tool-{name}` | [x-ipe-tool.md](templates/x-ipe-tool.md) | [skill-meta-x-ipe-tool.md](templates/skill-meta-x-ipe-tool.md) |
|
|
37
|
+
| x-ipe-workflow-orchestration | Multi-skill coordination | `x-ipe-workflow-{name}` | [x-ipe-workflow-orchestration.md](templates/x-ipe-workflow-orchestration.md) | [skill-meta-x-ipe-task-based.md](templates/skill-meta-x-ipe-task-based.md) |
|
|
38
|
+
| x-ipe-meta | Creates/manages skills | `x-ipe-meta-{name}` | [x-ipe-meta.md](templates/x-ipe-meta.md) | [skill-meta-x-ipe-meta.md](templates/skill-meta-x-ipe-meta.md) |
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## Important Notes
|
|
43
|
+
|
|
44
|
+
BLOCKING: Read [skill-general-guidelines-v2.md](references/skill-general-guidelines-v2.md) for core principles and patterns before creating skills.
|
|
45
|
+
|
|
46
|
+
CRITICAL: SKILL.md body must stay under 500 lines. Move examples to references/.
|
|
47
|
+
|
|
48
|
+
MANDATORY: All 4 skill types have complete templates in the templates/ folder.
|
|
49
|
+
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
## Input Parameters
|
|
53
|
+
|
|
54
|
+
```yaml
|
|
55
|
+
input:
|
|
56
|
+
skill_name: "{skill-name}" # lowercase, hyphens, 1-64 chars
|
|
57
|
+
skill_type: x-ipe-task-based | x-ipe-task-category | x-ipe-tool | x-ipe-workflow-orchestration | x-ipe-meta
|
|
58
|
+
user_request: "{description of what skill should do}"
|
|
59
|
+
examples: [] # Concrete usage examples (optional)
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
---
|
|
63
|
+
|
|
64
|
+
## Definition of Ready
|
|
65
|
+
|
|
66
|
+
```xml
|
|
67
|
+
<definition_of_ready>
|
|
68
|
+
<checkpoint required="true">
|
|
69
|
+
<name>Skill Type Identified</name>
|
|
70
|
+
<verification>One of: x-ipe-task-based, x-ipe-task-category, x-ipe-tool, x-ipe-workflow-orchestration, x-ipe-meta</verification>
|
|
71
|
+
</checkpoint>
|
|
72
|
+
<checkpoint required="true">
|
|
73
|
+
<name>Skill Name Compliant</name>
|
|
74
|
+
<verification>Matches naming convention: x-ipe-{type}-{name} (lowercase, hyphens only, 1-64 chars)</verification>
|
|
75
|
+
</checkpoint>
|
|
76
|
+
<checkpoint required="true">
|
|
77
|
+
<name>User Request Clear</name>
|
|
78
|
+
<verification>Clear description of what skill should do</verification>
|
|
79
|
+
</checkpoint>
|
|
80
|
+
<checkpoint required="recommended">
|
|
81
|
+
<name>Concrete Examples Gathered</name>
|
|
82
|
+
<verification>At least 2 usage scenarios documented</verification>
|
|
83
|
+
</checkpoint>
|
|
84
|
+
<checkpoint required="recommended">
|
|
85
|
+
<name>Skill Meta Folder Exist</name>
|
|
86
|
+
<verification>Folder x-ipe-docs/skill-meta/ exists with necessary files</verification>
|
|
87
|
+
</checkpoint>
|
|
88
|
+
</definition_of_ready>
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
---
|
|
92
|
+
|
|
93
|
+
## Execution Flow
|
|
94
|
+
|
|
95
|
+
| Step | Name | Action | Gate |
|
|
96
|
+
|------|------|--------|------|
|
|
97
|
+
| 1 | Identify Skill Type | Determine type, select template | type selected |
|
|
98
|
+
| 2 | Gather Examples | Collect usage scenarios | >= 2 examples |
|
|
99
|
+
| 3 | Plan Resources | Identify scripts/references/templates | resources planned |
|
|
100
|
+
| 4 | Round 1: Meta + Draft | Create skill-meta.md + candidate/ (parallel sub-agents 1,2) | both complete |
|
|
101
|
+
| 5 | Round 2: Reflect + Tests | Reflect on candidate + generate tests (parallel sub-agents 3,4) | both complete |
|
|
102
|
+
| 6 | Round 3: Run Tests | Execute tests in sandbox (sub-agent 5) | tests executed |
|
|
103
|
+
| 7 | Round 4: Evaluate | Evaluate results (sub-agent 6) | evaluation complete |
|
|
104
|
+
| 8 | Merge/Iterate | Merge if pass, iterate if fail | decision made |
|
|
105
|
+
| 9 | Cross-References | Validate external references | all valid |
|
|
106
|
+
|
|
107
|
+
---
|
|
108
|
+
|
|
109
|
+
## Execution Procedure
|
|
110
|
+
|
|
111
|
+
```xml
|
|
112
|
+
<procedure name="skill-creation">
|
|
113
|
+
<!-- CRITICAL: Both DoR/DoD check elements below are MANDATORY -->
|
|
114
|
+
<execute_dor_checks_before_starting/>
|
|
115
|
+
<schedule_dod_checks_with_sub_agent_before_starting/>
|
|
116
|
+
|
|
117
|
+
<step_1>
|
|
118
|
+
<name>Identify Skill Type</name>
|
|
119
|
+
<action>
|
|
120
|
+
1. Determine skill type based on purpose
|
|
121
|
+
2. Select corresponding SKILL.md template from templates/
|
|
122
|
+
3. Select corresponding skill-meta.md template from templates/
|
|
123
|
+
4. IF Belong to end-to-end project lifecycle workflows β x-ipe-task-based:
|
|
124
|
+
- SKILL.md: templates/x-ipe-task-based.md
|
|
125
|
+
- skill-meta.md: templates/skill-meta-x-ipe-task-based.md
|
|
126
|
+
5. IF Utility functions or integrations β x-ipe-tool:
|
|
127
|
+
- SKILL.md: templates/x-ipe-tool.md
|
|
128
|
+
- skill-meta.md: templates/skill-meta-x-ipe-tool.md
|
|
129
|
+
6. IF Orchestrates other skills β x-ipe-workflow-orchestration:
|
|
130
|
+
- SKILL.md: templates/x-ipe-workflow-orchestration.md
|
|
131
|
+
- skill-meta.md: templates/skill-meta-x-ipe-task-based.md (same structure)
|
|
132
|
+
7. IF Creates/manages skills β x-ipe-meta:
|
|
133
|
+
- SKILL.md: templates/x-ipe-meta.md
|
|
134
|
+
- skill-meta.md: templates/skill-meta-x-ipe-meta.md
|
|
135
|
+
8. IF Category orchestration β x-ipe-task-category:
|
|
136
|
+
- SKILL.md: templates/x-ipe-workflow-orchestration.md
|
|
137
|
+
- skill-meta.md: templates/skill-meta-x-ipe-task-category.md
|
|
138
|
+
</action>
|
|
139
|
+
<constraints>
|
|
140
|
+
- BLOCKING: Must select exactly one skill type
|
|
141
|
+
- BLOCKING: Must identify both SKILL.md and skill-meta.md templates
|
|
142
|
+
</constraints>
|
|
143
|
+
<success_criteria>
|
|
144
|
+
- Skill type identified
|
|
145
|
+
- SKILL.md template path determined
|
|
146
|
+
- skill-meta.md template path determined
|
|
147
|
+
</success_criteria>
|
|
148
|
+
<output>skill_type, skill_template_path, skill_meta_template_path</output>
|
|
149
|
+
</step_1>
|
|
150
|
+
|
|
151
|
+
<step_2>
|
|
152
|
+
<name>Gather Concrete Examples</name>
|
|
153
|
+
<action>
|
|
154
|
+
1. Ask user for functionality requirements
|
|
155
|
+
2. Collect trigger phrase examples
|
|
156
|
+
3. Document expected outputs
|
|
157
|
+
</action>
|
|
158
|
+
<constraints>
|
|
159
|
+
- CRITICAL: Skip only if patterns already clearly understood
|
|
160
|
+
</constraints>
|
|
161
|
+
<success_criteria>
|
|
162
|
+
- At least 2 usage scenarios documented
|
|
163
|
+
- Trigger patterns identified
|
|
164
|
+
</success_criteria>
|
|
165
|
+
<output>examples[], trigger_patterns[]</output>
|
|
166
|
+
</step_2>
|
|
167
|
+
|
|
168
|
+
<step_3>
|
|
169
|
+
<name>Plan Bundled Resources</name>
|
|
170
|
+
<action>
|
|
171
|
+
1. Analyze examples for reusable patterns
|
|
172
|
+
2. Identify which resource types needed:
|
|
173
|
+
- scripts/: Same code rewritten repeatedly
|
|
174
|
+
- references/: Documentation agent should reference
|
|
175
|
+
- templates/: Skill produces standardized documents
|
|
176
|
+
</action>
|
|
177
|
+
<success_criteria>
|
|
178
|
+
- Resource requirements documented
|
|
179
|
+
</success_criteria>
|
|
180
|
+
<output>resources_plan[]</output>
|
|
181
|
+
</step_3>
|
|
182
|
+
|
|
183
|
+
<step_4>
|
|
184
|
+
<name>Round 1: Create Meta + Draft</name>
|
|
185
|
+
<requires>skill_type, skill_template_path, skill_meta_template_path, examples[], resources_plan[]</requires>
|
|
186
|
+
<action>
|
|
187
|
+
1. Load skill-meta template from {skill_meta_template_path}
|
|
188
|
+
2. Create skill-meta.md under x-ipe-docs/skill-meta/{skill-name}/ by filling template
|
|
189
|
+
3. Load SKILL.md template from {skill_template_path}
|
|
190
|
+
4. Create candidate/ under x-ipe-docs/skill-meta/{skill-name}/ with full skill structure
|
|
191
|
+
</action>
|
|
192
|
+
<constraints>
|
|
193
|
+
- BLOCKING: Both outputs must complete before Round 2
|
|
194
|
+
- BLOCKING: skill-meta.md MUST be created from template, not from scratch
|
|
195
|
+
- BLOCKING: SKILL.md MUST be created from template, not from scratch
|
|
196
|
+
</constraints>
|
|
197
|
+
<success_criteria>
|
|
198
|
+
- skill-meta.md exists (created from {skill_meta_template_path})
|
|
199
|
+
- candidate/ folder with SKILL.md exists (created from {skill_template_path})
|
|
200
|
+
</success_criteria>
|
|
201
|
+
<output>skill-meta.md, candidate/</output>
|
|
202
|
+
</step_4>
|
|
203
|
+
|
|
204
|
+
<step_5>
|
|
205
|
+
<name>Round 2: Reflect + Test Cases</name>
|
|
206
|
+
<requires>skill-meta.md, candidate/</requires>
|
|
207
|
+
<action>
|
|
208
|
+
1. Reflect on candidate against skill-meta
|
|
209
|
+
2. Generate test cases from acceptance criteria
|
|
210
|
+
</action>
|
|
211
|
+
<success_criteria>
|
|
212
|
+
- Candidate refined based on reflection
|
|
213
|
+
- test-cases.yaml created
|
|
214
|
+
</success_criteria>
|
|
215
|
+
<output>candidate/, test-cases.yaml</output>
|
|
216
|
+
</step_5>
|
|
217
|
+
|
|
218
|
+
<step_6>
|
|
219
|
+
<name>Round 3: Run Tests</name>
|
|
220
|
+
<requires>test-cases.yaml</requires>
|
|
221
|
+
<action>
|
|
222
|
+
1. Execute tests in sandbox environment
|
|
223
|
+
2. Save outputs to sandbox/ folder
|
|
224
|
+
</action>
|
|
225
|
+
<success_criteria>
|
|
226
|
+
- All tests executed
|
|
227
|
+
- Execution log recorded
|
|
228
|
+
</success_criteria>
|
|
229
|
+
<output>sandbox/{outputs}, execution-log.yaml</output>
|
|
230
|
+
</step_6>
|
|
231
|
+
|
|
232
|
+
<step_7>
|
|
233
|
+
<name>Round 4: Evaluate Results</name>
|
|
234
|
+
<requires>sandbox/{outputs}, execution-log.yaml</requires>
|
|
235
|
+
<action>
|
|
236
|
+
1. Evaluate sandbox outputs against expectations
|
|
237
|
+
2. Use self_check for structural/content validation
|
|
238
|
+
3. Use judge_agent for quality scoring with rubric
|
|
239
|
+
</action>
|
|
240
|
+
<success_criteria>
|
|
241
|
+
- Evaluation report generated
|
|
242
|
+
- Pass/fail determination made
|
|
243
|
+
</success_criteria>
|
|
244
|
+
<output>evaluation-report.yaml</output>
|
|
245
|
+
</step_7>
|
|
246
|
+
|
|
247
|
+
<step_8>
|
|
248
|
+
<name>Merge or Iterate</name>
|
|
249
|
+
<requires>evaluation-report.yaml</requires>
|
|
250
|
+
<action>
|
|
251
|
+
1. Check evaluation results
|
|
252
|
+
2. IF must_pass_rate == 100% AND should_pass_rate >= 80%:
|
|
253
|
+
- cp -r candidate/* .github/skills/{skill-name}/
|
|
254
|
+
- Update skill-version-history.md
|
|
255
|
+
- Proceed to Step 9
|
|
256
|
+
3. IF tests failed AND iteration_count < 3:
|
|
257
|
+
- Update candidate, re-run from Round 2
|
|
258
|
+
4. IF tests failed AND iteration_count >= 3:
|
|
259
|
+
- Escalate to human
|
|
260
|
+
</action>
|
|
261
|
+
<success_criteria>
|
|
262
|
+
- Skill merged OR iteration documented
|
|
263
|
+
</success_criteria>
|
|
264
|
+
<output>merge_status</output>
|
|
265
|
+
</step_8>
|
|
266
|
+
|
|
267
|
+
<step_9>
|
|
268
|
+
<name>Validate Cross-References</name>
|
|
269
|
+
<requires>merge_status == merged</requires>
|
|
270
|
+
<action>
|
|
271
|
+
1. Check copilot-instructions.md registration (x-ipe-task-based only)
|
|
272
|
+
2. Check task-execution-guideline registration (x-ipe-task-based only)
|
|
273
|
+
3. Verify bidirectional references
|
|
274
|
+
</action>
|
|
275
|
+
<constraints>
|
|
276
|
+
- MANDATORY: Task type skills must be registered in copilot-instructions.md
|
|
277
|
+
</constraints>
|
|
278
|
+
<success_criteria>
|
|
279
|
+
- Cross-references validated
|
|
280
|
+
</success_criteria>
|
|
281
|
+
<output>cross_references_valid</output>
|
|
282
|
+
</step_9>
|
|
283
|
+
|
|
284
|
+
<sub-agent-planning>
|
|
285
|
+
<sub_agent_1>
|
|
286
|
+
<sub_agent_definition>
|
|
287
|
+
<role>Meta Creator</role>
|
|
288
|
+
<prompt>Load skill-meta template from {skill_meta_template_path}, fill with skill-specific content (purpose, acceptance criteria, test scenarios). Output: x-ipe-docs/skill-meta/{skill-name}/skill-meta.md</prompt>
|
|
289
|
+
</sub_agent_definition>
|
|
290
|
+
<workflow_step_reference>step_4</workflow_step_reference>
|
|
291
|
+
</sub_agent_1>
|
|
292
|
+
<sub_agent_2>
|
|
293
|
+
<sub_agent_definition>
|
|
294
|
+
<role>Draft Creator</role>
|
|
295
|
+
<prompt>Load SKILL.md template from {skill_template_path}, fill with skill-specific content following guidelines. Output: x-ipe-docs/skill-meta/{skill-name}/candidate/</prompt>
|
|
296
|
+
</sub_agent_definition>
|
|
297
|
+
<workflow_step_reference>step_4</workflow_step_reference>
|
|
298
|
+
</sub_agent_2>
|
|
299
|
+
<sub_agent_3>
|
|
300
|
+
<sub_agent_definition>
|
|
301
|
+
<role>Reflector</role>
|
|
302
|
+
<prompt>Review candidate against skill-meta, identify gaps, suggest improvements</prompt>
|
|
303
|
+
</sub_agent_definition>
|
|
304
|
+
<workflow_step_reference>step_5</workflow_step_reference>
|
|
305
|
+
<starting_condition>
|
|
306
|
+
- "START after sub_agent_1 and sub_agent_2 complete"
|
|
307
|
+
</starting_condition>
|
|
308
|
+
</sub_agent_3>
|
|
309
|
+
<sub_agent_4>
|
|
310
|
+
<sub_agent_definition>
|
|
311
|
+
<role>Test Generator</role>
|
|
312
|
+
<prompt>Generate test-cases.yaml from acceptance criteria in skill-meta.md</prompt>
|
|
313
|
+
</sub_agent_definition>
|
|
314
|
+
<workflow_step_reference>step_5</workflow_step_reference>
|
|
315
|
+
<starting_condition>
|
|
316
|
+
- "START after sub_agent_1 and sub_agent_2 complete"
|
|
317
|
+
</starting_condition>
|
|
318
|
+
</sub_agent_4>
|
|
319
|
+
<sub_agent_5>
|
|
320
|
+
<sub_agent_definition>
|
|
321
|
+
<role>Test Runner</role>
|
|
322
|
+
<prompt>Execute test cases in sandbox, record outputs and execution log</prompt>
|
|
323
|
+
</sub_agent_definition>
|
|
324
|
+
<workflow_step_reference>step_6</workflow_step_reference>
|
|
325
|
+
<starting_condition>
|
|
326
|
+
- "START after sub_agent_3 and sub_agent_4 complete"
|
|
327
|
+
</starting_condition>
|
|
328
|
+
</sub_agent_5>
|
|
329
|
+
<sub_agent_6>
|
|
330
|
+
<sub_agent_definition>
|
|
331
|
+
<role>Evaluator</role>
|
|
332
|
+
<prompt>Evaluate sandbox outputs against expectations, generate evaluation-report.yaml</prompt>
|
|
333
|
+
</sub_agent_definition>
|
|
334
|
+
<workflow_step_reference>step_7</workflow_step_reference>
|
|
335
|
+
<starting_condition>
|
|
336
|
+
- "START after sub_agent_5 completes"
|
|
337
|
+
</starting_condition>
|
|
338
|
+
</sub_agent_6>
|
|
339
|
+
</sub-agent-planning>
|
|
340
|
+
|
|
341
|
+
</procedure>
|
|
342
|
+
```
|
|
343
|
+
|
|
344
|
+
---
|
|
345
|
+
|
|
346
|
+
## Output Result
|
|
347
|
+
|
|
348
|
+
```yaml
|
|
349
|
+
task_completion_output:
|
|
350
|
+
category: standalone
|
|
351
|
+
status: completed | blocked
|
|
352
|
+
next_task_type: null
|
|
353
|
+
require_human_review: yes
|
|
354
|
+
task_output_links:
|
|
355
|
+
- ".github/skills/{skill-name}/SKILL.md"
|
|
356
|
+
- "x-ipe-docs/skill-meta/{skill-name}/skill-meta.md"
|
|
357
|
+
# Dynamic attributes
|
|
358
|
+
skill_name: "{skill-name}"
|
|
359
|
+
skill_type: "{skill_type}"
|
|
360
|
+
test_pass_rate: "{percentage}"
|
|
361
|
+
```
|
|
362
|
+
|
|
363
|
+
---
|
|
364
|
+
|
|
365
|
+
## Definition of Done
|
|
366
|
+
|
|
367
|
+
CRITICAL: Use a sub-agent to validate DoD checkpoints independently.
|
|
368
|
+
|
|
369
|
+
```xml
|
|
370
|
+
<definition_of_done>
|
|
371
|
+
<!-- Step Output Verification -->
|
|
372
|
+
<checkpoint required="true">
|
|
373
|
+
<name>Step 1-3 Outputs Complete</name>
|
|
374
|
+
<verification>skill_type, template_path, examples[], resources_plan[] defined</verification>
|
|
375
|
+
<step_output>skill_type, template_path, examples[], trigger_patterns[], resources_plan[]</step_output>
|
|
376
|
+
</checkpoint>
|
|
377
|
+
<checkpoint required="true">
|
|
378
|
+
<name>Step 4 Outputs Complete</name>
|
|
379
|
+
<verification>skill-meta.md and candidate/ folder created</verification>
|
|
380
|
+
<step_output>skill-meta.md, candidate/</step_output>
|
|
381
|
+
</checkpoint>
|
|
382
|
+
<checkpoint required="true">
|
|
383
|
+
<name>Step 5 Outputs Complete</name>
|
|
384
|
+
<verification>test-cases.yaml exists in x-ipe-docs/skill-meta/{skill-name}/</verification>
|
|
385
|
+
<step_output>candidate/, test-cases.yaml</step_output>
|
|
386
|
+
</checkpoint>
|
|
387
|
+
<checkpoint required="true">
|
|
388
|
+
<name>Step 6 Outputs Complete</name>
|
|
389
|
+
<verification>sandbox/ folder with test outputs and execution-log.yaml exist</verification>
|
|
390
|
+
<step_output>sandbox/{outputs}, execution-log.yaml</step_output>
|
|
391
|
+
</checkpoint>
|
|
392
|
+
<checkpoint required="true">
|
|
393
|
+
<name>Step 7 Outputs Complete</name>
|
|
394
|
+
<verification>evaluation-report.yaml exists with pass/fail results</verification>
|
|
395
|
+
<step_output>evaluation-report.yaml</step_output>
|
|
396
|
+
</checkpoint>
|
|
397
|
+
<checkpoint required="true">
|
|
398
|
+
<name>Step 8 Output Complete</name>
|
|
399
|
+
<verification>Skill merged to .github/skills/{skill-name}/ or iteration documented</verification>
|
|
400
|
+
<step_output>merge_status</step_output>
|
|
401
|
+
</checkpoint>
|
|
402
|
+
<checkpoint required="true">
|
|
403
|
+
<name>Step 9 Output Complete</name>
|
|
404
|
+
<verification>Cross-references validated (copilot-instructions.md if x-ipe-task-based)</verification>
|
|
405
|
+
<step_output>cross_references_valid</step_output>
|
|
406
|
+
</checkpoint>
|
|
407
|
+
|
|
408
|
+
<!-- Quality Verification -->
|
|
409
|
+
<checkpoint required="true">
|
|
410
|
+
<name>Candidate SKILL.md Created</name>
|
|
411
|
+
<verification>File exists at x-ipe-docs/skill-meta/{skill-name}/candidate/SKILL.md</verification>
|
|
412
|
+
</checkpoint>
|
|
413
|
+
<checkpoint required="true">
|
|
414
|
+
<name>SKILL.md Created</name>
|
|
415
|
+
<verification>File exists at .github/skills/{skill-name}/SKILL.md</verification>
|
|
416
|
+
</checkpoint>
|
|
417
|
+
<checkpoint required="true">
|
|
418
|
+
<name>Frontmatter Valid</name>
|
|
419
|
+
<verification>name (1-64 chars) and description (includes triggers)</verification>
|
|
420
|
+
</checkpoint>
|
|
421
|
+
<checkpoint required="true">
|
|
422
|
+
<name>Section Order Correct</name>
|
|
423
|
+
<verification>Follows cognitive flow per skill type</verification>
|
|
424
|
+
</checkpoint>
|
|
425
|
+
<checkpoint required="true">
|
|
426
|
+
<name>Line Count Under Limit</name>
|
|
427
|
+
<verification>SKILL.md < 500 lines</verification>
|
|
428
|
+
</checkpoint>
|
|
429
|
+
<checkpoint required="true">
|
|
430
|
+
<name>Keywords Used</name>
|
|
431
|
+
<verification>Uses BLOCKING/CRITICAL/MANDATORY (not emoji)</verification>
|
|
432
|
+
</checkpoint>
|
|
433
|
+
<checkpoint required="true">
|
|
434
|
+
<name>Step Outputs Covered in Created Skill</name>
|
|
435
|
+
<verification>Every step output in created skill has corresponding DoD checkpoint</verification>
|
|
436
|
+
</checkpoint>
|
|
437
|
+
<checkpoint required="true">
|
|
438
|
+
<name>Cross-References Valid</name>
|
|
439
|
+
<verification>Registered in copilot-instructions.md (if x-ipe-task-based)</verification>
|
|
440
|
+
</checkpoint>
|
|
441
|
+
</definition_of_done>
|
|
442
|
+
```
|
|
443
|
+
|
|
444
|
+
---
|
|
445
|
+
|
|
446
|
+
## Templates
|
|
447
|
+
|
|
448
|
+
| Template | Purpose |
|
|
449
|
+
|----------|---------|
|
|
450
|
+
| [x-ipe-task-based.md](templates/x-ipe-task-based.md) | SKILL.md for task-based skills |
|
|
451
|
+
| [x-ipe-tool.md](templates/x-ipe-tool.md) | SKILL.md for tool skills |
|
|
452
|
+
| [x-ipe-workflow-orchestration.md](templates/x-ipe-workflow-orchestration.md) | SKILL.md for workflow/task-category skills |
|
|
453
|
+
| [x-ipe-meta.md](templates/x-ipe-meta.md) | SKILL.md for meta skills |
|
|
454
|
+
| [skill-meta-x-ipe-task-based.md](templates/skill-meta-x-ipe-task-based.md) | skill-meta for task-based/workflow skills |
|
|
455
|
+
| [skill-meta-x-ipe-tool.md](templates/skill-meta-x-ipe-tool.md) | skill-meta for tool skills |
|
|
456
|
+
| [skill-meta-x-ipe-task-category.md](templates/skill-meta-x-ipe-task-category.md) | skill-meta for task-category skills |
|
|
457
|
+
| [skill-meta-x-ipe-meta.md](templates/skill-meta-x-ipe-meta.md) | skill-meta for meta skills |
|
|
458
|
+
|
|
459
|
+
BLOCKING: Always use the appropriate template. Never create SKILL.md or skill-meta.md from scratch.
|
|
460
|
+
|
|
461
|
+
---
|
|
462
|
+
|
|
463
|
+
## References
|
|
464
|
+
|
|
465
|
+
| File | Purpose |
|
|
466
|
+
|------|---------|
|
|
467
|
+
| [skill-general-guidelines-v2.md](references/skill-general-guidelines-v2.md) | Core principles, patterns, standards |
|
|
468
|
+
| [2. reference-section-order.md](references/2.%20reference-section-order.md) | Section ordering guide |
|
|
469
|
+
| [3-6. example-*.md](references/) | Workflow pattern examples (step-based, function-based) |
|
|
470
|
+
| [7-10. example-*.md](references/) | Task IO, structured summary, DoR/DoD, gate conditions |
|
|
471
|
+
| [11. reference-quality-standards.md](references/11.%20reference-quality-standards.md) | Quality standards |
|
|
472
|
+
| [examples.md](references/examples.md) | Concrete execution examples |
|
|
473
|
+
|
|
474
|
+
---
|
|
475
|
+
|
|
476
|
+
## Example
|
|
477
|
+
|
|
478
|
+
See [references/examples.md](references/examples.md) for concrete execution examples.
|
|
479
|
+
|
|
480
|
+
---
|
|
481
|
+
|
|
482
|
+
## Related Skills
|
|
483
|
+
|
|
484
|
+
| Skill | Purpose |
|
|
485
|
+
|-------|---------|
|
|
486
|
+
| `lesson-learned` | Capture issues and feedback after skill execution |
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# Example: Gate Conditions
|
|
2
|
+
|
|
3
|
+
Demonstrates Gate Conditions patterns for complex branching logic as alternative to DoR/DoD.
|
|
4
|
+
|
|
5
|
+
## Quality Gate
|
|
6
|
+
|
|
7
|
+
```yaml
|
|
8
|
+
gate:
|
|
9
|
+
name: "Quality Gate"
|
|
10
|
+
conditions:
|
|
11
|
+
logic: AND
|
|
12
|
+
checks:
|
|
13
|
+
- type: threshold
|
|
14
|
+
condition: "test_coverage >= 80%"
|
|
15
|
+
- type: completion
|
|
16
|
+
condition: "all_tests_pass == true"
|
|
17
|
+
- type: completion
|
|
18
|
+
condition: "no_critical_issues == true"
|
|
19
|
+
on_pass: "Proceed to deployment"
|
|
20
|
+
on_fail: "Return to implementation with issues list"
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Approval Gate with Fallback
|
|
24
|
+
|
|
25
|
+
```yaml
|
|
26
|
+
gate:
|
|
27
|
+
name: "Design Approval"
|
|
28
|
+
conditions:
|
|
29
|
+
logic: OR
|
|
30
|
+
checks:
|
|
31
|
+
- type: approval
|
|
32
|
+
condition: "tech_lead_approved == true"
|
|
33
|
+
- type: approval
|
|
34
|
+
condition: "two_senior_devs_approved == true"
|
|
35
|
+
on_pass: "Proceed to implementation"
|
|
36
|
+
on_fail: "Request review from tech lead"
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Tiered Release Gate
|
|
40
|
+
|
|
41
|
+
```yaml
|
|
42
|
+
gate:
|
|
43
|
+
name: "Release Readiness"
|
|
44
|
+
conditions:
|
|
45
|
+
logic: AND
|
|
46
|
+
checks:
|
|
47
|
+
- type: threshold
|
|
48
|
+
condition: "test_coverage >= 90%"
|
|
49
|
+
- type: completion
|
|
50
|
+
condition: "security_scan_passed == true"
|
|
51
|
+
- type: completion
|
|
52
|
+
condition: "performance_baseline_met == true"
|
|
53
|
+
- type: approval
|
|
54
|
+
condition: "product_owner_signoff == true"
|
|
55
|
+
on_pass: "Deploy to production"
|
|
56
|
+
on_fail: "Block release, notify team lead"
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## Conditional Skip Gate
|
|
60
|
+
|
|
61
|
+
```yaml
|
|
62
|
+
gate:
|
|
63
|
+
name: "Documentation Gate"
|
|
64
|
+
conditions:
|
|
65
|
+
logic: OR
|
|
66
|
+
checks:
|
|
67
|
+
- type: completion
|
|
68
|
+
condition: "docs_updated == true"
|
|
69
|
+
- type: completion
|
|
70
|
+
condition: "no_public_api_changes == true"
|
|
71
|
+
on_pass: "Proceed to merge"
|
|
72
|
+
on_fail: "Update documentation before merge"
|
|
73
|
+
```
|
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
# Reference: Quality Standards
|
|
2
|
+
|
|
3
|
+
Detailed quality reference for skill creation including importance keywords, common mistakes, and exclusions.
|
|
4
|
+
|
|
5
|
+
## Importance Keywords
|
|
6
|
+
|
|
7
|
+
```yaml
|
|
8
|
+
importance_keywords:
|
|
9
|
+
status_symbols:
|
|
10
|
+
description: Keep for human readability in boards/tracking
|
|
11
|
+
symbols:
|
|
12
|
+
β
: Complete
|
|
13
|
+
π: In progress
|
|
14
|
+
β³: Pending
|
|
15
|
+
π«: Blocked
|
|
16
|
+
βΈοΈ: Deferred
|
|
17
|
+
β: Cancelled
|
|
18
|
+
|
|
19
|
+
importance_keywords:
|
|
20
|
+
description: Use instead of symbols for importance signals in skill content
|
|
21
|
+
keywords:
|
|
22
|
+
BLOCKING:
|
|
23
|
+
meaning: Must not skip, halts execution
|
|
24
|
+
replaces: "β"
|
|
25
|
+
CRITICAL:
|
|
26
|
+
meaning: High priority, affects correctness
|
|
27
|
+
replaces: "β οΈ π΄"
|
|
28
|
+
MANDATORY:
|
|
29
|
+
meaning: Required, continue with warning if missing
|
|
30
|
+
replaces: "β οΈ"
|
|
31
|
+
REQUIRED:
|
|
32
|
+
meaning: Needed for completion
|
|
33
|
+
replaces: "β
(as requirement)"
|
|
34
|
+
OPTIONAL:
|
|
35
|
+
meaning: Can skip without impact
|
|
36
|
+
replaces: "π’"
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Common Mistakes (Anti-Patterns)
|
|
40
|
+
|
|
41
|
+
```yaml
|
|
42
|
+
anti_patterns:
|
|
43
|
+
- pattern: Missing DoR/DoD
|
|
44
|
+
reason: No clear entry/exit criteria
|
|
45
|
+
fix: Add entry/exit criteria tables
|
|
46
|
+
|
|
47
|
+
- pattern: Vague description in frontmatter
|
|
48
|
+
reason: Agent can't determine when to trigger skill
|
|
49
|
+
fix: Be specific about triggers in description
|
|
50
|
+
|
|
51
|
+
- pattern: No blocking rules
|
|
52
|
+
reason: Critical rules may be skipped
|
|
53
|
+
fix: Add BLOCKING: rules to Execution Flow
|
|
54
|
+
|
|
55
|
+
- pattern: Missing skill prerequisite
|
|
56
|
+
reason: Agent may start without required context
|
|
57
|
+
fix: Add Important Notes section
|
|
58
|
+
|
|
59
|
+
- pattern: Examples inline in SKILL.md
|
|
60
|
+
reason: Bloats context when examples not needed
|
|
61
|
+
fix: Move to references/examples.md
|
|
62
|
+
|
|
63
|
+
- pattern: SKILL.md > 500 lines
|
|
64
|
+
reason: Exceeds recommended token budget
|
|
65
|
+
fix: Split into reference files
|
|
66
|
+
|
|
67
|
+
- pattern: Sections out of order
|
|
68
|
+
reason: Inconsistent structure confuses agent
|
|
69
|
+
fix: Reorder to match template
|
|
70
|
+
|
|
71
|
+
- pattern: Using β οΈ/β for importance
|
|
72
|
+
reason: Agents pattern-match keywords better
|
|
73
|
+
fix: Use BLOCKING:, CRITICAL:, MANDATORY:
|
|
74
|
+
|
|
75
|
+
- pattern: Data models as prose
|
|
76
|
+
reason: Agents parse structured data better
|
|
77
|
+
fix: Use YAML blocks with explicit types
|
|
78
|
+
|
|
79
|
+
- pattern: Complex skill without sub-agents
|
|
80
|
+
reason: Missing parallelization opportunity
|
|
81
|
+
fix: Consider DAG workflow decomposition
|
|
82
|
+
|
|
83
|
+
- pattern: Wrong workflow pattern
|
|
84
|
+
reason: Using simple YAML for complex procedures loses clarity
|
|
85
|
+
fix: Match pattern to workflow complexity (see Pattern Selection Guide)
|
|
86
|
+
|
|
87
|
+
- pattern: "When to Use" in body
|
|
88
|
+
reason: Body only loaded after triggering
|
|
89
|
+
fix: Put trigger info in frontmatter description
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
## What NOT to Include
|
|
93
|
+
|
|
94
|
+
```yaml
|
|
95
|
+
excluded_files:
|
|
96
|
+
description: A skill should contain ONLY essential files
|
|
97
|
+
do_not_create:
|
|
98
|
+
- README.md
|
|
99
|
+
- INSTALLATION_GUIDE.md
|
|
100
|
+
- QUICK_REFERENCE.md
|
|
101
|
+
- CHANGELOG.md
|
|
102
|
+
- Setup/testing procedures
|
|
103
|
+
- User-facing documentation
|
|
104
|
+
|
|
105
|
+
rationale: |
|
|
106
|
+
Skill is for AI Agent to learn and execute, not for human onboarding.
|
|
107
|
+
Auxiliary documentation adds clutter and wastes context tokens.
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
## Quick Reference: Keyword Usage
|
|
111
|
+
|
|
112
|
+
| Keyword | When to Use | Example |
|
|
113
|
+
|---------|-------------|---------|
|
|
114
|
+
| `BLOCKING:` | Must halt if violated | `BLOCKING: Do not proceed without approval` |
|
|
115
|
+
| `CRITICAL:` | High priority warning | `CRITICAL: Backup data before migration` |
|
|
116
|
+
| `MANDATORY:` | Required but can warn | `MANDATORY: Include test coverage` |
|
|
117
|
+
| `REQUIRED:` | Needed for completion | `REQUIRED: Feature ID must exist` |
|
|
118
|
+
| `OPTIONAL:` | Can skip safely | `OPTIONAL: Add inline comments` |
|
|
119
|
+
|
|
120
|
+
## Quick Reference: Symbol Usage
|
|
121
|
+
|
|
122
|
+
| Context | Use Symbols? | Reason |
|
|
123
|
+
|---------|--------------|--------|
|
|
124
|
+
| Task boards | β
Yes | Human readability |
|
|
125
|
+
| Status tracking | β
Yes | Visual scanning |
|
|
126
|
+
| Skill instructions | β No | Keywords more reliable |
|
|
127
|
+
| Importance signals | β No | Agents pattern-match better |
|