moai-adk 0.5.2__py3-none-any.whl → 0.5.6__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.
Potentially problematic release.
This version of moai-adk might be problematic. Click here for more details.
- moai_adk/__init__.py +1 -1
- moai_adk/cli/commands/backup.py +25 -1
- moai_adk/cli/commands/doctor.py +30 -4
- moai_adk/cli/commands/init.py +23 -2
- moai_adk/cli/commands/status.py +32 -2
- moai_adk/cli/commands/update.py +47 -8
- moai_adk/core/project/initializer.py +13 -11
- moai_adk/core/project/phase_executor.py +9 -4
- moai_adk/core/template/processor.py +60 -1
- moai_adk/templates/.claude/agents/alfred/cc-manager.md +8 -0
- moai_adk/templates/.claude/agents/alfred/debug-helper.md +18 -0
- moai_adk/templates/.claude/agents/alfred/doc-syncer.md +18 -0
- moai_adk/templates/.claude/agents/alfred/git-manager.md +38 -2
- moai_adk/templates/.claude/agents/alfred/implementation-planner.md +18 -0
- moai_adk/templates/.claude/agents/alfred/project-manager.md +6 -0
- moai_adk/templates/.claude/agents/alfred/quality-gate.md +6 -0
- moai_adk/templates/.claude/agents/alfred/skill-factory.md +8 -0
- moai_adk/templates/.claude/agents/alfred/spec-builder.md +17 -0
- moai_adk/templates/.claude/agents/alfred/tag-agent.md +7 -1
- moai_adk/templates/.claude/agents/alfred/tdd-implementer.md +18 -0
- moai_adk/templates/.claude/agents/alfred/trust-checker.md +6 -0
- moai_adk/templates/.claude/commands/alfred/0-project.md +5 -1
- moai_adk/templates/.claude/commands/alfred/1-plan.md +5 -1
- moai_adk/templates/.claude/commands/alfred/2-run.md +6 -2
- moai_adk/templates/.claude/commands/alfred/3-sync.md +28 -7
- moai_adk/templates/.claude/hooks/alfred/alfred_hooks.py +5 -1
- moai_adk/templates/.claude/output-styles/alfred/agentic-coding.md +5 -1
- moai_adk/templates/.claude/output-styles/alfred/moai-adk-learning.md +5 -1
- moai_adk/templates/.claude/output-styles/alfred/study-with-alfred.md +5 -1
- moai_adk/templates/.claude/skills/moai-alfred-interactive-questions/SKILL.md +30 -273
- moai_adk/templates/.claude/skills/moai-alfred-interactive-questions/examples.md +487 -129
- moai_adk/templates/.claude/skills/moai-alfred-interactive-questions/reference.md +603 -70
- moai_adk/templates/.claude/skills/moai-cc-agents/SKILL.md +22 -2
- moai_adk/templates/.claude/skills/moai-cc-claude-md/SKILL.md +22 -2
- moai_adk/templates/.claude/skills/moai-cc-commands/SKILL.md +22 -2
- moai_adk/templates/.claude/skills/moai-cc-hooks/SKILL.md +22 -2
- moai_adk/templates/.claude/skills/moai-cc-mcp-plugins/SKILL.md +22 -2
- moai_adk/templates/.claude/skills/moai-cc-memory/SKILL.md +22 -2
- moai_adk/templates/.claude/skills/moai-cc-settings/SKILL.md +22 -2
- moai_adk/templates/.claude/skills/moai-cc-skills/SKILL.md +25 -5
- moai_adk/templates/.claude/skills/moai-essentials-debug/SKILL.md +152 -547
- moai_adk/templates/.claude/skills/moai-essentials-debug/examples.md +835 -878
- moai_adk/templates/.claude/skills/moai-essentials-debug/reference.md +665 -1151
- moai_adk/templates/.claude/skills/moai-skill-factory/SKILL.md +138 -427
- moai_adk/templates/.claude/skills/moai-spec-authoring/README.md +61 -53
- moai_adk/templates/.claude/skills/moai-spec-authoring/SKILL.md +99 -1181
- moai_adk/templates/.claude/skills/moai-spec-authoring/examples.md +541 -0
- moai_adk/templates/.claude/skills/moai-spec-authoring/reference.md +622 -0
- moai_adk/templates/.moai/config.json +5 -5
- moai_adk/templates/.moai/memory/CLAUDE-AGENTS-GUIDE.md +208 -0
- moai_adk/templates/.moai/memory/CLAUDE-PRACTICES.md +369 -0
- moai_adk/templates/.moai/memory/CLAUDE-RULES.md +539 -0
- moai_adk/templates/.moai/memory/{development-guide.md → DEVELOPMENT-GUIDE.md} +3 -3
- moai_adk/templates/.moai/memory/SKILLS-DESCRIPTION-POLICY.md +218 -0
- moai_adk/templates/.moai/memory/config-schema.md +444 -0
- moai_adk/templates/CLAUDE.md +142 -702
- {moai_adk-0.5.2.dist-info → moai_adk-0.5.6.dist-info}/METADATA +294 -336
- {moai_adk-0.5.2.dist-info → moai_adk-0.5.6.dist-info}/RECORD +63 -56
- /moai_adk/templates/.moai/memory/{gitflow-protection-policy.md → GITFLOW-PROTECTION-POLICY.md} +0 -0
- /moai_adk/templates/.moai/memory/{spec-metadata.md → SPEC-METADATA.md} +0 -0
- {moai_adk-0.5.2.dist-info → moai_adk-0.5.6.dist-info}/WHEEL +0 -0
- {moai_adk-0.5.2.dist-info → moai_adk-0.5.6.dist-info}/entry_points.txt +0 -0
- {moai_adk-0.5.2.dist-info → moai_adk-0.5.6.dist-info}/licenses/LICENSE +0 -0
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: moai-skill-factory
|
|
3
|
-
version: 2.
|
|
3
|
+
version: 2.1.0
|
|
4
4
|
created: 2025-10-22
|
|
5
|
-
updated: 2025-10-
|
|
5
|
+
updated: 2025-10-27
|
|
6
6
|
status: active
|
|
7
7
|
description: Create and maintain high-quality Claude Code Skills through interactive discovery, web research, and continuous updates. Use when building new Skills, researching latest best practices, updating existing Skills with current information, or generating Skill packages backed by official documentation and real-world examples.
|
|
8
8
|
keywords: [skill-creation, claude-skills, best-practices, web-research, interactive-discovery, skill-updates]
|
|
@@ -14,125 +14,85 @@ allowed-tools:
|
|
|
14
14
|
- WebFetch
|
|
15
15
|
- WebSearch
|
|
16
16
|
---
|
|
17
|
-
# Generating High-Quality Claude Code Skills
|
|
18
17
|
|
|
19
|
-
|
|
18
|
+
# Skill Factory - High-Quality Skill Creation System
|
|
19
|
+
|
|
20
|
+
## Skill Metadata
|
|
21
|
+
|
|
22
|
+
| Field | Value |
|
|
23
|
+
| ----- | ----- |
|
|
24
|
+
| Version | 2.1.0 |
|
|
25
|
+
| Tier | Special |
|
|
26
|
+
| Auto-load | Proactively when building Skills |
|
|
27
|
+
| Purpose | Interactive discovery → Web research → Skill generation |
|
|
20
28
|
|
|
21
29
|
---
|
|
22
30
|
|
|
23
|
-
## What
|
|
31
|
+
## What It Does
|
|
24
32
|
|
|
25
|
-
|
|
33
|
+
Interactive discovery, web research, continuous updates를 통한 고품질 Claude Code Skill 생성 및 유지관리 시스템을 제공합니다.
|
|
26
34
|
|
|
27
|
-
|
|
35
|
+
**Core capabilities**:
|
|
36
|
+
- ✅ Interactive user surveys via `moai-alfred-interactive-questions`
|
|
37
|
+
- ✅ Web research for latest information (WebFetch/WebSearch)
|
|
38
|
+
- ✅ Skill analysis and update recommendations
|
|
39
|
+
- ✅ Official documentation validation
|
|
40
|
+
- ✅ Progressive Disclosure pattern
|
|
41
|
+
- ✅ Multi-model compatibility testing
|
|
28
42
|
|
|
29
|
-
|
|
43
|
+
---
|
|
30
44
|
|
|
31
|
-
|
|
32
|
-
Level 1: Metadata (Always Active)
|
|
33
|
-
├── name, description, allowed-tools
|
|
34
|
-
└── ~100 tokens total (minimal overhead)
|
|
35
|
-
↓
|
|
36
|
-
Level 2: Instructions (Triggered On Demand)
|
|
37
|
-
├── SKILL.md main body (workflows, patterns, best practices)
|
|
38
|
-
└── Loads when Claude recognizes relevance to the request
|
|
39
|
-
↓
|
|
40
|
-
Level 3: Resources (As Needed)
|
|
41
|
-
├── Supporting files (reference.md, examples.md)
|
|
42
|
-
├── Scripts, templates
|
|
43
|
-
└── Consumed only when explicitly referenced or accessed
|
|
44
|
-
```
|
|
45
|
+
## When to Use
|
|
45
46
|
|
|
46
|
-
|
|
47
|
+
- 새로운 Skill 패키지를 생성할 때
|
|
48
|
+
- 최신 best practices와 공식 문서를 조사할 때
|
|
49
|
+
- 기존 Skill을 분석하고 업데이트할 때
|
|
50
|
+
- Skill generation workflow를 orchestrate할 때
|
|
47
51
|
|
|
48
52
|
---
|
|
49
53
|
|
|
50
|
-
## Core Principles
|
|
54
|
+
## Core Principles
|
|
51
55
|
|
|
52
56
|
### 1. Conciseness Over Completeness
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
✅ Do: Reference patterns, provide decision trees, link to examples
|
|
57
|
-
```
|
|
58
|
-
|
|
59
|
-
SKILL.md should stay **under 500 lines**. Trust that Claude is already intelligent—provide guidance, not lectures.
|
|
57
|
+
- SKILL.md should stay **under 500 words**
|
|
58
|
+
- Trust that Claude is already intelligent—provide guidance, not lectures
|
|
59
|
+
- Reference patterns, provide decision trees, link to supporting files
|
|
60
60
|
|
|
61
61
|
### 2. Appropriate Freedom Levels
|
|
62
62
|
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
|
66
|
-
|
|
|
67
|
-
| **
|
|
68
|
-
| **Medium** | Standard patterns exist | Data validation workflows | Pseudocode, flowcharts, annotated code |
|
|
69
|
-
| **Low** | Deterministic, error-prone | Bash operations, file handling | Specific scripts with error handling |
|
|
70
|
-
|
|
71
|
-
### 3. Multi-Model Testing
|
|
72
|
-
|
|
73
|
-
Verify Skill works across:
|
|
74
|
-
- **Haiku**: Can it understand concise examples? Does it activate correctly?
|
|
75
|
-
- **Sonnet**: Does it exploit the full Skill? Synthesize across sections?
|
|
76
|
-
- **Opus**: Can it extend patterns beyond examples?
|
|
77
|
-
|
|
78
|
-
### 4. Consistent Terminology
|
|
79
|
-
|
|
80
|
-
```
|
|
81
|
-
✅ Good: Use "migration", "index", "constraint" consistently
|
|
82
|
-
❌ Bad: Switch between "migration", "schema change", "version bump"
|
|
83
|
-
```
|
|
63
|
+
| Freedom Level | When to Use | Content Style |
|
|
64
|
+
| ------------- | ----------- | ------------- |
|
|
65
|
+
| **High** | Flexible, creative work | Principles, trade-offs, considerations |
|
|
66
|
+
| **Medium** | Standard patterns exist | Pseudocode, flowcharts, annotated code |
|
|
67
|
+
| **Low** | Deterministic, error-prone | Specific scripts with error handling |
|
|
84
68
|
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
### 5. Progressive Disclosure Through Linking
|
|
69
|
+
### 3. Three-Level Progressive Disclosure
|
|
88
70
|
|
|
89
71
|
```
|
|
90
|
-
|
|
91
|
-
├──
|
|
92
|
-
└──
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
├──
|
|
96
|
-
└──
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
├──
|
|
100
|
-
└──
|
|
72
|
+
Level 1: Metadata (Always Active)
|
|
73
|
+
├── name, description, allowed-tools
|
|
74
|
+
└── ~100 tokens total
|
|
75
|
+
↓
|
|
76
|
+
Level 2: Instructions (On Demand)
|
|
77
|
+
├── SKILL.md main body
|
|
78
|
+
└── Loads when Claude recognizes relevance
|
|
79
|
+
↓
|
|
80
|
+
Level 3: Resources (As Needed)
|
|
81
|
+
├── reference.md, examples.md
|
|
82
|
+
└── Consumed when explicitly referenced
|
|
101
83
|
```
|
|
102
84
|
|
|
103
|
-
Never create deeply nested structures—one level of indirection is enough.
|
|
104
|
-
|
|
105
85
|
---
|
|
106
86
|
|
|
107
|
-
##
|
|
87
|
+
## Quick Start: Creating a Skill
|
|
108
88
|
|
|
109
|
-
###
|
|
89
|
+
### 5-Step Process (Total: ~2 hours)
|
|
110
90
|
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
├── reference.md # Detailed reference docs (optional)
|
|
117
|
-
├── examples.md # 3-4 real-world examples (optional)
|
|
118
|
-
├── CHECKLIST.md # Quality validation (optional)
|
|
119
|
-
├── scripts/ # Utility scripts
|
|
120
|
-
│ ├── helper_script.sh
|
|
121
|
-
│ └── validator.py
|
|
122
|
-
└── templates/ # Reusable templates
|
|
123
|
-
├── template_main.md
|
|
124
|
-
└── config-template.json
|
|
125
|
-
```
|
|
126
|
-
|
|
127
|
-
### Rules for File Organization
|
|
128
|
-
|
|
129
|
-
| Rule | Rationale | Example |
|
|
130
|
-
| ------------------- | ---------------------------- | ----------------------------------------------------- |
|
|
131
|
-
| One level deep | Avoids nested discovery | ✅ `reference.md` not `docs/reference/api.md` |
|
|
132
|
-
| Relative paths | Cross-platform compatibility | ✅ `[see reference.md](reference.md)` not `./docs/...` |
|
|
133
|
-
| Forward slashes | Unix convention | ✅ `scripts/helper.sh` not `scripts\helper.sh` |
|
|
134
|
-
| Clear naming | Self-documenting | ✅ `validate-skill.sh` not `v.sh` |
|
|
135
|
-
| <500 lines per file | Manageable context | Split if SKILL.md exceeds 500 lines |
|
|
91
|
+
1. **Define Problem** (10 min): What gap does this Skill fill?
|
|
92
|
+
2. **Design Metadata** (10 min): Name (gerund + domain), description, allowed-tools
|
|
93
|
+
3. **Structure Content** (30 min): High (20%) + Medium (50%) + Low (30%) freedom
|
|
94
|
+
4. **Add Examples & References** (30 min): 3-4 examples, detailed reference
|
|
95
|
+
5. **Validate & Test** (20 min): CHECKLIST.md, multi-model testing
|
|
136
96
|
|
|
137
97
|
---
|
|
138
98
|
|
|
@@ -150,194 +110,53 @@ allowed-tools: "Tool1, Tool2, Tool3"
|
|
|
150
110
|
|
|
151
111
|
### Field Specifications
|
|
152
112
|
|
|
153
|
-
|
|
154
|
-
-
|
|
155
|
-
-
|
|
156
|
-
-
|
|
157
|
-
- ✅ "Processing CSV Files with Python"
|
|
158
|
-
- ✅ "Debugging Go Applications with Delve"
|
|
159
|
-
- ❌ "CSV Processing" (too generic)
|
|
160
|
-
- ❌ "Python CSV Helper Tool" (too descriptive)
|
|
161
|
-
|
|
162
|
-
#### `description` (Required)
|
|
163
|
-
- **Max 1024 characters**
|
|
164
|
-
- **Format**: Third person, action-oriented
|
|
165
|
-
- **Must include**:
|
|
166
|
-
- What the Skill does (capabilities)
|
|
167
|
-
- When to use it (trigger scenarios)
|
|
168
|
-
- 3+ discoverable keywords
|
|
169
|
-
|
|
170
|
-
**Template**:
|
|
171
|
-
```
|
|
172
|
-
"[Capability 1], [Capability 2], or [Capability 3].
|
|
173
|
-
Use when [trigger scenario 1], [trigger scenario 2],
|
|
174
|
-
or [trigger scenario 3]."
|
|
175
|
-
```
|
|
176
|
-
|
|
177
|
-
**Example**:
|
|
178
|
-
```
|
|
179
|
-
"Extract text and tables from PDF files, create and edit spreadsheets,
|
|
180
|
-
generate business reports, or merge documents. Use when working with
|
|
181
|
-
PDF documents, Excel files, CSV data, or when the user mentions document
|
|
182
|
-
extraction, data export, or report generation."
|
|
183
|
-
```
|
|
184
|
-
|
|
185
|
-
**Trigger Keywords** (examples):
|
|
186
|
-
- Problem domain: PDF, Excel, CSV, JSON, XML
|
|
187
|
-
- Operation: parsing, validation, transformation, cleaning
|
|
188
|
-
- Tech stack: Python, TypeScript, Go, Rust
|
|
189
|
-
- Pattern: algorithm, design pattern, architecture
|
|
190
|
-
|
|
191
|
-
#### `allowed-tools` (Recommended)
|
|
192
|
-
- **Minimal principle**: Only include tools the Skill actually uses
|
|
193
|
-
- **Format**: Comma-separated list of tool names and patterns
|
|
194
|
-
- **Examples**:
|
|
195
|
-
- `"Read, Grep, Glob"` (read-only analysis)
|
|
196
|
-
- `"Read, Write, Edit, Bash(git:*)"` (Git operations)
|
|
197
|
-
- `"Bash(python:*), Bash(pytest:*), Read"` (Python testing)
|
|
198
|
-
- `"Read, Bash(curl:*), Bash(jq:*)"` (API interaction)
|
|
199
|
-
|
|
200
|
-
---
|
|
201
|
-
|
|
202
|
-
## Content Structure: Freedom Level Framework
|
|
203
|
-
|
|
204
|
-
### High Freedom: Principles & Guidance (30-40% of SKILL.md)
|
|
205
|
-
|
|
206
|
-
For creative, flexible tasks where direction matters more than prescription.
|
|
207
|
-
|
|
208
|
-
**Content Type**:
|
|
209
|
-
- Core principles (3-5 key ideas)
|
|
210
|
-
- Trade-off analysis
|
|
211
|
-
- Decision matrices
|
|
212
|
-
- Consideration frameworks
|
|
213
|
-
|
|
214
|
-
**Example: Architecture Decisions**
|
|
215
|
-
```
|
|
216
|
-
## Architecture Trade-offs
|
|
217
|
-
|
|
218
|
-
| Pattern | Pros | Cons | When to use |
|
|
219
|
-
| ------------- | -------------------------- | --------------------------- | --------------------------- |
|
|
220
|
-
| Monolith | Simple to start | Scales poorly | MVP, <10 microservices |
|
|
221
|
-
| Microservices | Scales, independent deploy | Complex networking | 10+ teams, different stacks |
|
|
222
|
-
| Serverless | Zero ops, elastic | Cold starts, vendor lock-in | Event-driven, variable load |
|
|
223
|
-
```
|
|
113
|
+
**`name`** (Required):
|
|
114
|
+
- Max 64 characters
|
|
115
|
+
- Format: Gerund (action verb) + domain
|
|
116
|
+
- Example: "Processing CSV Files with Python"
|
|
224
117
|
|
|
225
|
-
|
|
118
|
+
**`description`** (Required):
|
|
119
|
+
- Max 1024 characters
|
|
120
|
+
- Format: Third person, action-oriented
|
|
121
|
+
- Must include: capabilities + trigger scenarios + 3+ keywords
|
|
226
122
|
|
|
227
|
-
|
|
123
|
+
**`allowed-tools`** (Recommended):
|
|
124
|
+
- Minimal principle: Only tools actually used
|
|
125
|
+
- Format: Comma-separated list
|
|
126
|
+
- Example: `"Read, Write, Edit, Bash(git:*)"`
|
|
228
127
|
|
|
229
|
-
**
|
|
230
|
-
- Pseudocode with annotations
|
|
231
|
-
- Flowcharts/decision trees
|
|
232
|
-
- Pattern examples (not production code)
|
|
233
|
-
- Configuration templates
|
|
234
|
-
|
|
235
|
-
**Example: Data Validation Workflow**
|
|
236
|
-
```
|
|
237
|
-
## Pseudocode Pattern: CSV Validation
|
|
238
|
-
|
|
239
|
-
```pseudocode
|
|
240
|
-
1. Load CSV file
|
|
241
|
-
2. For each column:
|
|
242
|
-
a. Check data type matches schema
|
|
243
|
-
b. Validate range/constraints
|
|
244
|
-
c. Flag missing values
|
|
245
|
-
3. If all checks pass:
|
|
246
|
-
✓ Proceed to transformation
|
|
247
|
-
4. Else:
|
|
248
|
-
✗ Report errors with row/column numbers
|
|
249
|
-
✗ Suggest fixes
|
|
250
|
-
```
|
|
251
|
-
|
|
252
|
-
### Low Freedom: Specific Scripts & Commands (10-20% of SKILL.md)
|
|
253
|
-
|
|
254
|
-
For deterministic, error-prone operations where exact execution matters.
|
|
255
|
-
|
|
256
|
-
**Content Type**:
|
|
257
|
-
- Ready-to-run Bash/Python scripts
|
|
258
|
-
- Error handling & validation
|
|
259
|
-
- Exit codes & logging
|
|
260
|
-
- Hardened templates
|
|
261
|
-
|
|
262
|
-
**Example: Safe File Operation**
|
|
263
|
-
```bash
|
|
264
|
-
#!/bin/bash
|
|
265
|
-
set -euo pipefail # Exit on error, undefined var, pipe fail
|
|
266
|
-
|
|
267
|
-
SOURCE_FILE="$1"
|
|
268
|
-
DEST_DIR="$2"
|
|
269
|
-
|
|
270
|
-
# Validation
|
|
271
|
-
if [[ ! -f "$SOURCE_FILE" ]]; then
|
|
272
|
-
echo "ERROR: Source file not found: $SOURCE_FILE" >&2
|
|
273
|
-
exit 1
|
|
274
|
-
fi
|
|
275
|
-
|
|
276
|
-
if [[ ! -d "$DEST_DIR" ]]; then
|
|
277
|
-
echo "ERROR: Destination directory not found: $DEST_DIR" >&2
|
|
278
|
-
exit 1
|
|
279
|
-
fi
|
|
280
|
-
|
|
281
|
-
# Safe copy with backup
|
|
282
|
-
cp "$SOURCE_FILE" "$DEST_DIR/"
|
|
283
|
-
echo "✓ File copied successfully to $DEST_DIR"
|
|
284
|
-
exit 0
|
|
285
|
-
```
|
|
128
|
+
> **Detailed metadata guide**: See [METADATA.md](METADATA.md)
|
|
286
129
|
|
|
287
130
|
---
|
|
288
131
|
|
|
289
|
-
##
|
|
132
|
+
## File Organization
|
|
290
133
|
|
|
291
|
-
###
|
|
292
|
-
|
|
293
|
-
**Audit Checklist**:
|
|
294
|
-
- [ ] Define each domain term once (glossary section)
|
|
295
|
-
- [ ] Use the same term consistently throughout (no synonyms)
|
|
296
|
-
- [ ] Italicize or bold terms on first use: *term*, **term**
|
|
297
|
-
|
|
298
|
-
**Example Glossary**:
|
|
299
|
-
```markdown
|
|
300
|
-
### Glossary
|
|
134
|
+
### Recommended Structure
|
|
301
135
|
|
|
302
|
-
- **Index**: B-tree data structure for search optimization
|
|
303
|
-
- **Constraint**: Data integrity rule (NOT "validation rule")
|
|
304
|
-
- **Migration**: Schema version change (NOT "upgrade", "deploy")
|
|
305
136
|
```
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
137
|
+
skill-name/
|
|
138
|
+
├── SKILL.md # Main instructions (~500 words)
|
|
139
|
+
├── reference.md # Detailed specs, API docs
|
|
140
|
+
├── examples.md # 3-4 real-world examples
|
|
141
|
+
├── CHECKLIST.md # Quality validation (optional)
|
|
142
|
+
├── scripts/ # Utility scripts
|
|
143
|
+
└── templates/ # Reusable templates
|
|
311
144
|
```
|
|
312
|
-
✅ GOOD:
|
|
313
|
-
## Pseudocode Pattern
|
|
314
|
-
[pattern description]
|
|
315
|
-
[pseudocode or flowchart]
|
|
316
145
|
|
|
317
|
-
###
|
|
318
|
-
[code example]
|
|
146
|
+
### Rules
|
|
319
147
|
|
|
320
|
-
|
|
321
|
-
|
|
148
|
+
| Rule | Rationale |
|
|
149
|
+
|------|-----------|
|
|
150
|
+
| One level deep | Avoids nested discovery |
|
|
151
|
+
| Relative paths | Cross-platform compatibility |
|
|
152
|
+
| Forward slashes | Unix convention |
|
|
153
|
+
| <500 lines per file | Manageable context |
|
|
322
154
|
|
|
323
|
-
|
|
324
|
-
## Pseudocode Pattern
|
|
325
|
-
[pattern description only, no examples]
|
|
326
|
-
```
|
|
327
|
-
|
|
328
|
-
### Anti-Patterns to Avoid
|
|
329
|
-
|
|
330
|
-
| Anti-Pattern | Example | Fix |
|
|
331
|
-
| ------------------- | ----------------------------------- | ------------------------------------------------ |
|
|
332
|
-
| Time-sensitive info | "Today's date is 2025-01-15" | "Use current system date" |
|
|
333
|
-
| Vague instructions | "Make it fast" | "Profile with [tool], measure [metric]" |
|
|
334
|
-
| Too many options | 10+ approaches listed | Pick 3 main approaches, others in "Alternatives" |
|
|
335
|
-
| Nested references | `docs/api/v2/reference/examples.md` | Keep to one level: `reference.md` |
|
|
336
|
-
| Windows paths | `docs\api\reference.md` | Use `/`: `docs/api/reference.md` |
|
|
155
|
+
> **Detailed organization guide**: See [STRUCTURE.md](STRUCTURE.md)
|
|
337
156
|
|
|
338
157
|
---
|
|
339
158
|
|
|
340
|
-
## Quality Validation
|
|
159
|
+
## Quality Validation
|
|
341
160
|
|
|
342
161
|
Before publishing, audit your Skill:
|
|
343
162
|
|
|
@@ -345,216 +164,108 @@ Before publishing, audit your Skill:
|
|
|
345
164
|
- [ ] `name` ≤ 64 characters, gerund format
|
|
346
165
|
- [ ] `description` ≤ 1024 chars, includes 3+ triggers
|
|
347
166
|
- [ ] `allowed-tools` is minimal and justified
|
|
348
|
-
- [ ] YAML frontmatter is valid (no tabs, proper indentation)
|
|
349
167
|
|
|
350
168
|
### Content Quality
|
|
351
|
-
- [ ] SKILL.md ≤ 500
|
|
169
|
+
- [ ] SKILL.md ≤ 500 words
|
|
352
170
|
- [ ] All major concepts have examples
|
|
353
|
-
- [ ] Terminology is consistent
|
|
354
|
-
- [ ]
|
|
355
|
-
- [ ] Progressive Disclosure pattern applied
|
|
356
|
-
- [ ] Relative paths used throughout
|
|
357
|
-
|
|
358
|
-
### Specificity & Discoverability
|
|
359
|
-
- [ ] Name is specific (not "Python Helper")
|
|
360
|
-
- [ ] Description includes problem domain keywords
|
|
361
|
-
- [ ] Triggers match likely user search terms
|
|
362
|
-
- [ ] Scope is bounded (1-3 related domains)
|
|
171
|
+
- [ ] Terminology is consistent
|
|
172
|
+
- [ ] Progressive Disclosure applied
|
|
363
173
|
|
|
364
174
|
### Multi-Model Compatibility
|
|
365
175
|
- [ ] Haiku can understand concise examples
|
|
366
176
|
- [ ] Sonnet exploits full Skill capabilities
|
|
367
177
|
- [ ] Opus can extend patterns beyond examples
|
|
368
178
|
|
|
369
|
-
|
|
370
|
-
- [ ] No credentials, API keys, or secrets in examples
|
|
371
|
-
- [ ] No system state assumptions (e.g., "assuming ~/config exists")
|
|
372
|
-
- [ ] Scripts include error handling & exit codes
|
|
373
|
-
- [ ] Dangerous operations (rm, mv) use explicit confirmations
|
|
179
|
+
> **Complete validation checklist**: See [CHECKLIST.md](CHECKLIST.md)
|
|
374
180
|
|
|
375
181
|
---
|
|
376
182
|
|
|
377
|
-
##
|
|
183
|
+
## Advanced Features
|
|
378
184
|
|
|
379
|
-
|
|
185
|
+
### Interactive Discovery
|
|
186
|
+
Use TUI surveys to clarify vague requirements and capture all user needs.
|
|
380
187
|
|
|
381
|
-
|
|
382
|
-
1. Is the task deterministic?
|
|
383
|
-
├─ YES: Well-defined algorithm, fixed steps
|
|
384
|
-
│ └─→ Low Freedom: Specific script with error handling
|
|
385
|
-
│ (Example: Bash file operations, deployment steps)
|
|
386
|
-
│
|
|
387
|
-
└─ NO: Flexible, context-dependent, multiple valid approaches
|
|
388
|
-
└─ Does the task have standard patterns?
|
|
389
|
-
├─ YES: Established best practice (e.g., validation)
|
|
390
|
-
│ └─→ Medium Freedom: Pseudocode + examples
|
|
391
|
-
│ (Example: Data validation, testing patterns)
|
|
392
|
-
│
|
|
393
|
-
└─ NO: Novel or creative work
|
|
394
|
-
└─→ High Freedom: Principles + considerations
|
|
395
|
-
(Example: Architecture design, code organization)
|
|
396
|
-
```
|
|
188
|
+
> **Detailed guide**: [INTERACTIVE-DISCOVERY.md](INTERACTIVE-DISCOVERY.md)
|
|
397
189
|
|
|
398
|
-
|
|
190
|
+
### Web Research
|
|
191
|
+
Gather latest information, best practices, and official documentation.
|
|
399
192
|
|
|
400
|
-
|
|
193
|
+
> **Detailed guide**: [WEB-RESEARCH.md](WEB-RESEARCH.md)
|
|
401
194
|
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
2. **Medium Freedom Example**: Testing Patterns Skill
|
|
405
|
-
3. **Low Freedom Example**: Deployment Automation Skill
|
|
195
|
+
### Skill Update Advisor
|
|
196
|
+
Analyze existing Skills and propose updates based on latest information.
|
|
406
197
|
|
|
407
|
-
|
|
198
|
+
> **Detailed guide**: [SKILL-UPDATE-ADVISOR.md](SKILL-UPDATE-ADVISOR.md)
|
|
408
199
|
|
|
409
200
|
---
|
|
410
201
|
|
|
411
|
-
##
|
|
202
|
+
## Common Failure Modes
|
|
412
203
|
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
├── examples.md
|
|
421
|
-
├── scripts/
|
|
422
|
-
└── templates/
|
|
423
|
-
```
|
|
424
|
-
|
|
425
|
-
2. **Add frontmatter** to SKILL.md:
|
|
426
|
-
```yaml
|
|
427
|
-
---
|
|
428
|
-
name: "[Gerund] [Domain]"
|
|
429
|
-
description: "[Capability]. Use when [trigger 1], [trigger 2]."
|
|
430
|
-
allowed-tools: "Tool1, Tool2"
|
|
431
|
-
---
|
|
432
|
-
```
|
|
433
|
-
|
|
434
|
-
3. **Structure content** (High + Medium + Low):
|
|
435
|
-
- Principles/overview (High)
|
|
436
|
-
- Patterns & pseudocode (Medium)
|
|
437
|
-
- Ready-to-run scripts (Low)
|
|
438
|
-
|
|
439
|
-
4. **Validate** against CHECKLIST.md
|
|
440
|
-
|
|
441
|
-
5. **Test** across Haiku, Sonnet, Opus
|
|
442
|
-
|
|
443
|
-
### Template Files
|
|
444
|
-
|
|
445
|
-
See `templates/` directory:
|
|
446
|
-
- `SKILL_TEMPLATE.md`: Base Skill structure
|
|
447
|
-
- `reference-template.md`: Supporting docs template
|
|
448
|
-
- `examples-template.md`: Example scenarios template
|
|
449
|
-
- `scripts-template.sh`: Error-handling Bash template
|
|
204
|
+
| Issue | Root Cause | Fix |
|
|
205
|
+
|-------|------------|-----|
|
|
206
|
+
| **Not activating** | Description too generic | Add 5+ specific keywords |
|
|
207
|
+
| **Haiku ignores it** | Examples too complex | Simplify pseudocode |
|
|
208
|
+
| **Over-specifying** | Too much low-freedom content | Increase principles |
|
|
209
|
+
| **Scope creep** | Covers too many domains | Split into 2-3 focused Skills |
|
|
210
|
+
| **File too large** | SKILL.md > 500 words | Move content to reference.md |
|
|
450
211
|
|
|
451
212
|
---
|
|
452
213
|
|
|
453
|
-
##
|
|
214
|
+
## Integration
|
|
454
215
|
|
|
455
|
-
|
|
456
|
-
| ------------------------ | ---------------------------- | ------------------------------------------------- |
|
|
457
|
-
| **Not activating** | Description too generic | Add 5+ specific keywords, mention common triggers |
|
|
458
|
-
| **Haiku ignores it** | Examples too complex | Simplify pseudocode, add short examples |
|
|
459
|
-
| **Over-specifying** | Too much low-freedom content | Reduce scripts, increase principles |
|
|
460
|
-
| **Scope creep** | Covers too many domains | Split into 2-3 focused Skills |
|
|
461
|
-
| **Terminology mismatch** | Terms used inconsistently | Audit and standardize with glossary |
|
|
462
|
-
| **File too large** | SKILL.md > 500 lines | Move content to reference.md or examples.md |
|
|
463
|
-
|
|
464
|
-
---
|
|
465
|
-
|
|
466
|
-
## Integration with moai-alfred-skill-generator
|
|
467
|
-
|
|
468
|
-
This Skill is invoked by the **moai-alfred-skill-generator** Sub-Agent during Skill creation phases:
|
|
216
|
+
### With moai-alfred-skill-generator Sub-Agent
|
|
469
217
|
|
|
470
218
|
```
|
|
471
219
|
User: "/alfred:1-plan Create Skill for X"
|
|
472
220
|
↓
|
|
473
221
|
skill-generator Sub-Agent (ANALYZE → DESIGN → ASSURE phases)
|
|
474
222
|
↓
|
|
475
|
-
moai-skill-
|
|
223
|
+
moai-skill-factory Skill (PRODUCE phase)
|
|
476
224
|
↓
|
|
477
225
|
Complete Skill package created
|
|
478
226
|
```
|
|
479
227
|
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
## Quick Start: Creating Your First Skill
|
|
483
|
-
|
|
484
|
-
### 5-Step Process
|
|
228
|
+
### Tools Used
|
|
485
229
|
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
230
|
+
- **WebFetch**: Fetch official documentation
|
|
231
|
+
- **WebSearch**: Search for latest best practices
|
|
232
|
+
- **Read/Glob**: Review existing Skills
|
|
233
|
+
- **Bash**: Directory creation, file operations
|
|
489
234
|
|
|
490
|
-
|
|
491
|
-
- Name (gerund + domain)
|
|
492
|
-
- Description (capabilities + triggers)
|
|
493
|
-
- Allowed-tools (minimal list)
|
|
494
|
-
|
|
495
|
-
3. **Structure Content** (30 min):
|
|
496
|
-
- High freedom: Principles (20%)
|
|
497
|
-
- Medium freedom: Patterns (50%)
|
|
498
|
-
- Low freedom: Scripts (30%)
|
|
499
|
-
|
|
500
|
-
4. **Add Examples & References** (30 min):
|
|
501
|
-
- 3-4 concrete examples in examples.md
|
|
502
|
-
- Detailed reference in reference.md
|
|
503
|
-
- Reusable templates in templates/
|
|
235
|
+
---
|
|
504
236
|
|
|
505
|
-
|
|
506
|
-
- Run through CHECKLIST.md
|
|
507
|
-
- Test with Haiku, Sonnet, Opus
|
|
508
|
-
- Peer review (if available)
|
|
237
|
+
## Related Skills
|
|
509
238
|
|
|
510
|
-
|
|
239
|
+
- `moai-alfred-interactive-questions`: Interactive user surveys (delegated)
|
|
240
|
+
- `moai-alfred-skill-generator`: Skill generation orchestrator
|
|
511
241
|
|
|
512
242
|
---
|
|
513
243
|
|
|
514
|
-
|
|
244
|
+
## Complete Documentation
|
|
515
245
|
|
|
516
|
-
|
|
246
|
+
**Core Guides**:
|
|
247
|
+
- [METADATA.md](METADATA.md) — Metadata authoring guide
|
|
248
|
+
- [STRUCTURE.md](STRUCTURE.md) — File organization patterns
|
|
249
|
+
- [CHECKLIST.md](CHECKLIST.md) — Pre-publication validation
|
|
517
250
|
|
|
518
|
-
|
|
519
|
-
-
|
|
520
|
-
-
|
|
521
|
-
-
|
|
251
|
+
**Advanced Features**:
|
|
252
|
+
- [INTERACTIVE-DISCOVERY.md](INTERACTIVE-DISCOVERY.md) — TUI survey patterns
|
|
253
|
+
- [WEB-RESEARCH.md](WEB-RESEARCH.md) — Web research strategies
|
|
254
|
+
- [SKILL-UPDATE-ADVISOR.md](SKILL-UPDATE-ADVISOR.md) — Skill analysis & updates
|
|
522
255
|
|
|
523
|
-
|
|
524
|
-
-
|
|
525
|
-
-
|
|
526
|
-
- Official documentation integration
|
|
527
|
-
- Fact-checking and deprecation detection
|
|
256
|
+
**Workflows**:
|
|
257
|
+
- [SKILL-FACTORY-WORKFLOW.md](SKILL-FACTORY-WORKFLOW.md) — Complete workflow
|
|
258
|
+
- [STEP-BY-STEP-GUIDE.md](STEP-BY-STEP-GUIDE.md) — Practical walkthrough
|
|
528
259
|
|
|
529
|
-
|
|
530
|
-
-
|
|
531
|
-
-
|
|
532
|
-
-
|
|
533
|
-
- Generating migration guides
|
|
260
|
+
**References**:
|
|
261
|
+
- [reference.md](reference.md) — Detailed API reference
|
|
262
|
+
- [examples.md](examples.md) — Real-world case studies
|
|
263
|
+
- [EXAMPLES.md](EXAMPLES.md) — Additional examples
|
|
534
264
|
|
|
535
265
|
---
|
|
536
266
|
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
- [METADATA.md](METADATA.md) — Metadata authoring guide
|
|
540
|
-
- [STRUCTURE.md](STRUCTURE.md) — File organization patterns
|
|
541
|
-
- [EXAMPLES.md](EXAMPLES.md) — Real-world Skill case studies
|
|
542
|
-
- [CHECKLIST.md](CHECKLIST.md) — Pre-publication validation
|
|
543
|
-
- [INTERACTIVE-DISCOVERY.md](INTERACTIVE-DISCOVERY.md) — TUI survey patterns (NEW)
|
|
544
|
-
- [WEB-RESEARCH.md](WEB-RESEARCH.md) — Web research strategies (NEW)
|
|
545
|
-
- [SKILL-UPDATE-ADVISOR.md](SKILL-UPDATE-ADVISOR.md) — Skill analysis & updates (NEW)
|
|
267
|
+
**Key Differentiator**: User-centric + research-driven + always-current + delegation-first orchestration
|
|
546
268
|
|
|
547
269
|
---
|
|
548
270
|
|
|
549
|
-
**
|
|
550
|
-
**Last Updated**: 2025-10-22
|
|
551
|
-
**Framework**: MoAI-ADK + Claude Skills + skill-factory Sub-Agent
|
|
552
|
-
**Status**: Production-ready
|
|
553
|
-
**Key Features**:
|
|
554
|
-
- ✅ Interactive user surveys via moai-alfred-interactive-questions
|
|
555
|
-
- ✅ Web research integration for latest information
|
|
556
|
-
- ✅ Skill analysis & update recommendations
|
|
557
|
-
- ✅ Official documentation validation
|
|
558
|
-
- ✅ Progressive Disclosure pattern
|
|
559
|
-
- ✅ Freedom level framework
|
|
560
|
-
- ✅ Multi-model compatibility testing
|
|
271
|
+
**End of Skill** | Refactored 2025-10-27
|