@anionzo/skill 1.1.0
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.
- package/CONTRIBUTING.md +302 -0
- package/LICENSE +21 -0
- package/README.md +209 -0
- package/adapters/README.md +13 -0
- package/adapters/claude-code/README.md +32 -0
- package/adapters/copilot/README.md +32 -0
- package/adapters/gemini/README.md +32 -0
- package/adapters/generic/README.md +32 -0
- package/adapters/opencode/README.md +32 -0
- package/docs/adapter-guide.md +62 -0
- package/docs/authoring-guide.md +69 -0
- package/docs/design-brief.md +97 -0
- package/docs/knowledge-spec.md +78 -0
- package/docs/research-notes.md +99 -0
- package/docs/skill-spec.md +107 -0
- package/i18n/CONTRIBUTING.vi.md +302 -0
- package/i18n/README.vi.md +209 -0
- package/i18n/adapter-guide.vi.md +62 -0
- package/i18n/authoring-guide.vi.md +69 -0
- package/i18n/design-brief.vi.md +97 -0
- package/i18n/knowledge-spec.vi.md +78 -0
- package/i18n/research-notes.vi.md +99 -0
- package/i18n/skill-spec.vi.md +107 -0
- package/knowledge/README.md +7 -0
- package/knowledge/global/debugging-patterns.md +20 -0
- package/knowledge/global/engineering-principles.md +23 -0
- package/knowledge/global/evidence-before-claims.md +20 -0
- package/knowledge/global/review-heuristics.md +23 -0
- package/knowledge/global/skill-triggering-rules.md +24 -0
- package/knowledge/project/README.md +10 -0
- package/knowledge/working/README.md +10 -0
- package/package.json +43 -0
- package/scripts/sync-platform-files +73 -0
- package/scripts/validate-skills +103 -0
- package/skills/brainstorming/SKILL.md +45 -0
- package/skills/brainstorming/examples.md +61 -0
- package/skills/brainstorming/meta.yaml +23 -0
- package/skills/brainstorming/references/output-template.md +26 -0
- package/skills/bug-triage/SKILL.md +47 -0
- package/skills/bug-triage/examples.md +68 -0
- package/skills/bug-triage/meta.yaml +25 -0
- package/skills/bug-triage/references/output-template.md +26 -0
- package/skills/code-review/SKILL.md +41 -0
- package/skills/code-review/examples.md +77 -0
- package/skills/code-review/meta.yaml +24 -0
- package/skills/code-review/references/checklist.md +34 -0
- package/skills/code-review/references/output-template.md +12 -0
- package/skills/docs-writer/SKILL.md +42 -0
- package/skills/docs-writer/examples.md +108 -0
- package/skills/docs-writer/meta.yaml +22 -0
- package/skills/docs-writer/references/output-template.md +17 -0
- package/skills/feature-delivery/SKILL.md +39 -0
- package/skills/feature-delivery/examples.md +83 -0
- package/skills/feature-delivery/meta.yaml +26 -0
- package/skills/feature-delivery/references/output-template.md +26 -0
- package/skills/planning/SKILL.md +61 -0
- package/skills/planning/examples.md +124 -0
- package/skills/planning/meta.yaml +29 -0
- package/skills/planning/references/output-template.md +37 -0
- package/skills/refactor-safe/SKILL.md +53 -0
- package/skills/refactor-safe/examples.md +96 -0
- package/skills/refactor-safe/meta.yaml +28 -0
- package/skills/refactor-safe/references/output-template.md +37 -0
- package/skills/repo-onboarding/SKILL.md +52 -0
- package/skills/repo-onboarding/examples.md +115 -0
- package/skills/repo-onboarding/meta.yaml +23 -0
- package/skills/repo-onboarding/references/output-template.md +24 -0
- package/skills/using-skills/SKILL.md +108 -0
- package/skills/using-skills/examples.md +79 -0
- package/skills/using-skills/meta.yaml +29 -0
- package/skills/using-skills/references/output-template.md +14 -0
- package/skills/verification-before-completion/SKILL.md +46 -0
- package/skills/verification-before-completion/examples.md +83 -0
- package/skills/verification-before-completion/meta.yaml +26 -0
- package/skills/verification-before-completion/references/checklist.md +7 -0
- package/skills/verification-before-completion/references/output-template.md +16 -0
- package/templates/SKILL.md +29 -0
- package/templates/examples.md +13 -0
- package/templates/meta.yaml +14 -0
- package/templates/output-template.md +11 -0
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# OpenCode Adapter
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
This adapter generates platform-specific instruction files for OpenCode.
|
|
6
|
+
|
|
7
|
+
## How It Works
|
|
8
|
+
|
|
9
|
+
1. Run `bash scripts/sync-platform-files` to generate `generated/OPENCODE.md`
|
|
10
|
+
2. Copy the generated file to your project root as `OPENCODE.md`
|
|
11
|
+
3. The agent will automatically read this file and apply the skill library
|
|
12
|
+
|
|
13
|
+
## Copy Flow
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
# Generate
|
|
17
|
+
bash scripts/sync-platform-files
|
|
18
|
+
|
|
19
|
+
# Copy to your project
|
|
20
|
+
cp generated/OPENCODE.md OPENCODE.md
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Platform Notes
|
|
24
|
+
|
|
25
|
+
- OpenCode reads `OPENCODE.md` from the project root automatically
|
|
26
|
+
- Place the file at the root of your repository for best results
|
|
27
|
+
- OpenCode will reference this file at the start of each session
|
|
28
|
+
|
|
29
|
+
## Source
|
|
30
|
+
|
|
31
|
+
- Generated from: `generated/OPENCODE.md`
|
|
32
|
+
- Core skill library: `skills/` and `knowledge/`
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# 🔌 Adapter Guide
|
|
2
|
+
|
|
3
|
+
> 🇻🇳 **[Tiếng Việt](../i18n/adapter-guide.vi.md)**
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
### 🎯 Goal
|
|
8
|
+
|
|
9
|
+
Adapters make the same skill library usable across multiple agent platforms without rewriting the core content.
|
|
10
|
+
|
|
11
|
+
> 📁 Core files stay in `skills/` and `knowledge/`.
|
|
12
|
+
> 📦 Platform-specific files are generated into `generated/`.
|
|
13
|
+
|
|
14
|
+
### 🤖 Current Targets
|
|
15
|
+
|
|
16
|
+
| | Agent | Output File |
|
|
17
|
+
|---|---|---|
|
|
18
|
+
| 🤖 | Claude Code | `CLAUDE.md` |
|
|
19
|
+
| ⚡ | OpenCode | `OPENCODE.md` |
|
|
20
|
+
| 💎 | Gemini CLI | `GEMINI.md` |
|
|
21
|
+
| 🔧 | Generic agents | `AGENTS.md` |
|
|
22
|
+
| 🐙 | GitHub Copilot | `.github/copilot-instructions.md` |
|
|
23
|
+
|
|
24
|
+
### 📋 Current Strategy
|
|
25
|
+
|
|
26
|
+
The first version does not try to fully translate every skill into platform-specific syntax.
|
|
27
|
+
|
|
28
|
+
Instead it generates concise platform files that:
|
|
29
|
+
|
|
30
|
+
- 🧭 Point to the core skill router
|
|
31
|
+
- 📚 Point to the most important knowledge files
|
|
32
|
+
- 📋 Include a small skill catalog
|
|
33
|
+
- 📏 State working rules that should be stable across platforms
|
|
34
|
+
|
|
35
|
+
> 💡 This keeps the delivery artifacts short and reduces drift.
|
|
36
|
+
|
|
37
|
+
### 🔄 Sync Flow
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
bash scripts/sync-platform-files
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
This writes fresh files into `generated/`.
|
|
44
|
+
|
|
45
|
+
### 📋 Copy Flow
|
|
46
|
+
|
|
47
|
+
After sync, copy the output file to the target repo:
|
|
48
|
+
|
|
49
|
+
| Source | Target |
|
|
50
|
+
|---|---|
|
|
51
|
+
| `generated/CLAUDE.md` | `CLAUDE.md` |
|
|
52
|
+
| `generated/OPENCODE.md` | `OPENCODE.md` |
|
|
53
|
+
| `generated/GEMINI.md` | `GEMINI.md` |
|
|
54
|
+
| `generated/AGENTS.md` | `AGENTS.md` |
|
|
55
|
+
| `generated/copilot-instructions.md` | `.github/copilot-instructions.md` |
|
|
56
|
+
|
|
57
|
+
### 🔮 Future Improvements
|
|
58
|
+
|
|
59
|
+
- 📋 Machine-readable skill manifest
|
|
60
|
+
- 🏷️ Selective sync by tag or platform
|
|
61
|
+
- 📁 Project overlays that add `knowledge/project/` automatically
|
|
62
|
+
- 🔌 MCP or CLI delivery for skill discovery
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
# ✍️ Authoring Guide
|
|
2
|
+
|
|
3
|
+
> 🇻🇳 **[Tiếng Việt](../i18n/authoring-guide.vi.md)**
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
### ➕ Creating A New Skill
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
Step 1 📁 Create skills/<name>/
|
|
11
|
+
Step 2 📋 Copy files from templates/
|
|
12
|
+
Step 3 📄 Fill in meta.yaml first
|
|
13
|
+
Step 4 📖 Write SKILL.md around a single repeatable job
|
|
14
|
+
Step 5 💡 Add one realistic example
|
|
15
|
+
Step 6 📂 Add one support file in references/ if needed
|
|
16
|
+
Step 7 ✅ Run bash scripts/validate-skills
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
### 📄 Writing `meta.yaml`
|
|
20
|
+
|
|
21
|
+
Start by answering four questions:
|
|
22
|
+
|
|
23
|
+
| # | Question |
|
|
24
|
+
|---|---|
|
|
25
|
+
| 1️⃣ | What is the skill called? |
|
|
26
|
+
| 2️⃣ | What category does it belong to? |
|
|
27
|
+
| 3️⃣ | What problem does it solve? |
|
|
28
|
+
| 4️⃣ | When should an agent reach for it? |
|
|
29
|
+
|
|
30
|
+
> ⚠️ If the agent would struggle to decide when to load the skill, the metadata is still too vague.
|
|
31
|
+
|
|
32
|
+
### 📖 Writing `SKILL.md`
|
|
33
|
+
|
|
34
|
+
Good skill files are **operational**:
|
|
35
|
+
|
|
36
|
+
- ⏰ Describe when the skill should be loaded
|
|
37
|
+
- 🔢 Give a small number of concrete steps
|
|
38
|
+
- 📋 Define how the result should be reported
|
|
39
|
+
- 🚩 Call out the common mistakes the skill is meant to prevent
|
|
40
|
+
- ➡️ Define whether the skill hands off to another skill or ends the flow
|
|
41
|
+
|
|
42
|
+
### 💡 Examples
|
|
43
|
+
|
|
44
|
+
Examples should look like **realistic prompts or tasks**, not abstract descriptions.
|
|
45
|
+
|
|
46
|
+
Include:
|
|
47
|
+
|
|
48
|
+
- 🗣️ A representative user request
|
|
49
|
+
- 📋 The intended response shape or chosen workflow
|
|
50
|
+
- 🔑 Any key assumptions that affect routing
|
|
51
|
+
|
|
52
|
+
### ☑️ Review Checklist
|
|
53
|
+
|
|
54
|
+
Before keeping a new skill, check that:
|
|
55
|
+
|
|
56
|
+
| | Check |
|
|
57
|
+
|---|---|
|
|
58
|
+
| 🏷️ | The name is specific |
|
|
59
|
+
| 📝 | The summary is one sentence and still useful |
|
|
60
|
+
| 🔄 | The workflow can be followed without extra private context |
|
|
61
|
+
| 📋 | The output format is consistent |
|
|
62
|
+
| 💡 | The example is realistic |
|
|
63
|
+
| ✅ | The done criteria require evidence, not wishful language |
|
|
64
|
+
|
|
65
|
+
### ✏️ Editing Existing Skills
|
|
66
|
+
|
|
67
|
+
When refining a skill, prefer **tightening scope** over adding more branches.
|
|
68
|
+
|
|
69
|
+
> 💡 If a skill starts handling too many unrelated cases, **split it** into two skills instead of making one file harder to reason about.
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
# 📋 Design Brief
|
|
2
|
+
|
|
3
|
+
> 🇻🇳 **[Tiếng Việt](../i18n/design-brief.vi.md)**
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
### ❓ Problem
|
|
8
|
+
|
|
9
|
+
AI workflows often break down for one of two reasons:
|
|
10
|
+
|
|
11
|
+
- 🔴 The agent does not have a repeatable method for a class of work
|
|
12
|
+
- 🔴 The agent does not have durable context about how the user prefers to work
|
|
13
|
+
|
|
14
|
+
This repository separates those two concerns.
|
|
15
|
+
|
|
16
|
+
### 📦 What This Repo Is
|
|
17
|
+
|
|
18
|
+
A personal operating library with three layers:
|
|
19
|
+
|
|
20
|
+
| Layer | Purpose |
|
|
21
|
+
|---|---|
|
|
22
|
+
| 🎯 `skills/` | Reusable workflow instructions |
|
|
23
|
+
| 📚 `knowledge/` | Durable notes about principles, heuristics, and project context |
|
|
24
|
+
| 🔌 `adapters/` | Delivery guidance for different agent platforms |
|
|
25
|
+
|
|
26
|
+
### 🚫 What This Repo Is Not
|
|
27
|
+
|
|
28
|
+
- ❌ Not a full task manager
|
|
29
|
+
- ❌ Not a plugin runtime
|
|
30
|
+
- ❌ Not a database-backed memory system
|
|
31
|
+
- ❌ Not a single-agent hard-coded prompt pack
|
|
32
|
+
|
|
33
|
+
### 🔍 Upstream Ideas Adopted
|
|
34
|
+
|
|
35
|
+
#### From [`hoangnb24/skills`](https://github.com/hoangnb24/skills)
|
|
36
|
+
|
|
37
|
+
- 🔹 Workflow-first skill design
|
|
38
|
+
- 🔹 A router or meta-skill that decides what to load next
|
|
39
|
+
- 🔹 Explicit output contracts
|
|
40
|
+
- 🔹 References and examples stored next to each skill
|
|
41
|
+
|
|
42
|
+
#### From plan-first coding agents
|
|
43
|
+
|
|
44
|
+
- 🔹 Separate planning from execution
|
|
45
|
+
- 🔹 Make implementation readiness visible before code changes begin
|
|
46
|
+
- 🔹 Keep plans concrete enough to execute and easy to review
|
|
47
|
+
|
|
48
|
+
#### From [`obra/superpowers`](https://github.com/obra/superpowers)
|
|
49
|
+
|
|
50
|
+
- 🔹 Add a brainstorming stage before planning when the request is still fuzzy
|
|
51
|
+
- 🔹 Treat verification as a real gate, not a final afterthought
|
|
52
|
+
- 🔹 Keep skill triggering and workflow transitions explicit
|
|
53
|
+
|
|
54
|
+
#### From [`affaan-m/everything-claude-code`](https://github.com/affaan-m/everything-claude-code)
|
|
55
|
+
|
|
56
|
+
- 🔹 Think in layers: skills, stable rules, memory, adapters
|
|
57
|
+
- 🔹 Treat cross-platform support as a first-class concern
|
|
58
|
+
- 🔹 Keep room for future automation around skill activation and testing
|
|
59
|
+
|
|
60
|
+
#### From [`knowns-dev/knowns`](https://github.com/knowns-dev/knowns)
|
|
61
|
+
|
|
62
|
+
- 🔹 Separate skill instructions from durable knowledge
|
|
63
|
+
- 🔹 Keep one source of truth and sync platform-specific files from it
|
|
64
|
+
- 🔹 Support multiple target agents without rewriting the core library
|
|
65
|
+
- 🔹 Leave room for a future machine-readable interface
|
|
66
|
+
|
|
67
|
+
### 🏛️ Design Decisions
|
|
68
|
+
|
|
69
|
+
1. 📄 Core content lives in Markdown and YAML so the repo stays portable
|
|
70
|
+
2. 🎯 Skills are narrow by default and should solve one repeatable problem well
|
|
71
|
+
3. 📚 Knowledge is layered as `global`, `project`, and `working`
|
|
72
|
+
4. 📦 Platform files are generated into `generated/` instead of edited manually
|
|
73
|
+
5. ⚙️ The first version uses simple shell scripts instead of introducing a build system
|
|
74
|
+
6. ✅ Planning and verification are explicit phases for code-changing work
|
|
75
|
+
|
|
76
|
+
### 🎯 Initial Scope
|
|
77
|
+
|
|
78
|
+
The first version focuses on the work patterns most likely to pay off immediately:
|
|
79
|
+
|
|
80
|
+
- 🧭 Routing requests
|
|
81
|
+
- 💡 Refining rough requests into a workable direction
|
|
82
|
+
- 🗺️ Onboarding into repos
|
|
83
|
+
- 🐛 Triaging bugs
|
|
84
|
+
- 📐 Planning implementation work before code edits
|
|
85
|
+
- 🚀 Delivering features
|
|
86
|
+
- ✅ Verifying outcomes before claiming completion
|
|
87
|
+
- 🔍 Reviewing code
|
|
88
|
+
- 📝 Updating docs
|
|
89
|
+
|
|
90
|
+
### 🔮 Next Steps
|
|
91
|
+
|
|
92
|
+
If the library proves useful, the likely follow-up work is:
|
|
93
|
+
|
|
94
|
+
1. 📋 Add a skill manifest format that is easier to parse programmatically
|
|
95
|
+
2. 📦 Generate richer platform files from metadata and selected knowledge files
|
|
96
|
+
3. 🧩 Add project-specific packs that extend the global library
|
|
97
|
+
4. 🔌 Expose the library through a lightweight MCP server or CLI
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
# 📚 Knowledge Spec
|
|
2
|
+
|
|
3
|
+
> 🇻🇳 **[Tiếng Việt](../i18n/knowledge-spec.vi.md)**
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
### 🎯 Purpose
|
|
8
|
+
|
|
9
|
+
Knowledge files store durable context that improves how skills are applied.
|
|
10
|
+
|
|
11
|
+
> 🎯 **Skills** explain *how to work*.
|
|
12
|
+
> 📚 **Knowledge** explains *what matters in your environment*.
|
|
13
|
+
|
|
14
|
+
### 📂 Layers
|
|
15
|
+
|
|
16
|
+
#### 🌍 `knowledge/global/`
|
|
17
|
+
|
|
18
|
+
Use for cross-project rules and preferences:
|
|
19
|
+
|
|
20
|
+
- 🏛️ Engineering principles
|
|
21
|
+
- 🔍 Review heuristics
|
|
22
|
+
- 🐛 Debugging patterns
|
|
23
|
+
- ✍️ Writing tone
|
|
24
|
+
|
|
25
|
+
> 🐢 This layer should change **slowly**.
|
|
26
|
+
|
|
27
|
+
#### 📁 `knowledge/project/`
|
|
28
|
+
|
|
29
|
+
Use for project-specific context:
|
|
30
|
+
|
|
31
|
+
- 🏗️ Architecture notes
|
|
32
|
+
- ⚙️ Important commands
|
|
33
|
+
- 📏 Conventions
|
|
34
|
+
- ⚠️ Rollout risks
|
|
35
|
+
- 📋 Domain rules
|
|
36
|
+
|
|
37
|
+
> 🔄 This layer should be copied or adapted **per project**.
|
|
38
|
+
|
|
39
|
+
#### 📝 `knowledge/working/`
|
|
40
|
+
|
|
41
|
+
Use for session-scoped or temporary notes:
|
|
42
|
+
|
|
43
|
+
- 🧪 Active hypotheses
|
|
44
|
+
- ⏳ Temporary decisions
|
|
45
|
+
- 📌 Follow-ups to promote later
|
|
46
|
+
|
|
47
|
+
> ⚡ This layer changes **often** and can be cleaned up aggressively.
|
|
48
|
+
|
|
49
|
+
### 📄 File Shape
|
|
50
|
+
|
|
51
|
+
Knowledge files should stay readable as plain Markdown.
|
|
52
|
+
|
|
53
|
+
**Recommended sections:**
|
|
54
|
+
|
|
55
|
+
| Section | Purpose |
|
|
56
|
+
|---|---|
|
|
57
|
+
| 🎯 Why this exists | Context and motivation |
|
|
58
|
+
| 📏 Rules or heuristics | Actionable guidelines |
|
|
59
|
+
| 💡 Examples | Concrete illustrations |
|
|
60
|
+
| ⚠️ What should not be assumed | Guard against misuse |
|
|
61
|
+
|
|
62
|
+
> Frontmatter is optional. Start simple unless you need machine-readable tags.
|
|
63
|
+
|
|
64
|
+
### ⬆️ Promotion Rules
|
|
65
|
+
|
|
66
|
+
Promote an insight upward when it has repeated value:
|
|
67
|
+
|
|
68
|
+
| From | To | When |
|
|
69
|
+
|---|---|---|
|
|
70
|
+
| 📝 `working` | 📁 `project` | When it matters for the current codebase beyond one session |
|
|
71
|
+
| 📁 `project` | 🌍 `global` | When the pattern repeatedly helps across repos |
|
|
72
|
+
|
|
73
|
+
### 🚫 Anti-Patterns
|
|
74
|
+
|
|
75
|
+
- ❌ Mixing task-specific notes into `global/`
|
|
76
|
+
- ❌ Storing volatile scratch notes as permanent truth
|
|
77
|
+
- ❌ Copying full skill instructions into knowledge files
|
|
78
|
+
- ❌ Letting project files drift away from the real codebase
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
# 🔬 Research Notes
|
|
2
|
+
|
|
3
|
+
> 🇻🇳 **[Tiếng Việt](../i18n/research-notes.vi.md)**
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
### 🎯 Goal
|
|
8
|
+
|
|
9
|
+
This note records the strongest external patterns worth adapting into this personal skill library.
|
|
10
|
+
|
|
11
|
+
### 📦 Repositories Reviewed
|
|
12
|
+
|
|
13
|
+
#### 🏛️ [`anthropics/skills`](https://github.com/anthropics/skills)
|
|
14
|
+
|
|
15
|
+
**Why it matters:**
|
|
16
|
+
|
|
17
|
+
- Clean public example of portable skill packaging
|
|
18
|
+
- Extremely simple core contract: a skill is a folder with `SKILL.md`
|
|
19
|
+
- Good reminder that skills should stay self-contained and discoverable
|
|
20
|
+
|
|
21
|
+
**Patterns adopted here:**
|
|
22
|
+
|
|
23
|
+
- 🔹 One skill per folder
|
|
24
|
+
- 🔹 Clear name and description
|
|
25
|
+
- 🔹 Examples close to the skill itself
|
|
26
|
+
|
|
27
|
+
#### ⚡ [`obra/superpowers`](https://github.com/obra/superpowers)
|
|
28
|
+
|
|
29
|
+
**Why it matters:**
|
|
30
|
+
|
|
31
|
+
- Strongest public example of a skill-driven software delivery workflow
|
|
32
|
+
- Keeps brainstorm, plan, execution, review, and verification as separate steps
|
|
33
|
+
- Treats skill triggering and workflow transitions as design problems, not accidents
|
|
34
|
+
|
|
35
|
+
**Patterns adopted here:**
|
|
36
|
+
|
|
37
|
+
- 🔹 Explicit `brainstorming` stage for unclear requests
|
|
38
|
+
- 🔹 Explicit `planning` stage before non-trivial code changes
|
|
39
|
+
- 🔹 Explicit `verification-before-completion` gate
|
|
40
|
+
|
|
41
|
+
#### 🧩 [`affaan-m/everything-claude-code`](https://github.com/affaan-m/everything-claude-code)
|
|
42
|
+
|
|
43
|
+
**Why it matters:**
|
|
44
|
+
|
|
45
|
+
- Shows how a large skill ecosystem can grow into layers: skills, rules, memory, hooks, adapters
|
|
46
|
+
- Demonstrates strong cross-platform packaging discipline
|
|
47
|
+
- Treats research, verification, and skill evolution as first-class concerns
|
|
48
|
+
|
|
49
|
+
**Patterns adopted here:**
|
|
50
|
+
|
|
51
|
+
- 🔹 Separation between `skills/`, `knowledge/`, and `adapters/`
|
|
52
|
+
- 🔹 Room for future always-on rules and richer platform output
|
|
53
|
+
- 🔹 Focus on reusable operating guidance instead of one-off prompts
|
|
54
|
+
|
|
55
|
+
#### 🗃️ [`knowns-dev/knowns`](https://github.com/knowns-dev/knowns)
|
|
56
|
+
|
|
57
|
+
**Why it matters:**
|
|
58
|
+
|
|
59
|
+
- Strong example of separating context and memory from skill instructions
|
|
60
|
+
- Good model for generating platform instruction files from one source
|
|
61
|
+
|
|
62
|
+
**Patterns adopted here:**
|
|
63
|
+
|
|
64
|
+
- 🔹 Durable notes live in `knowledge/`
|
|
65
|
+
- 🔹 Platform files are generated instead of manually diverging
|
|
66
|
+
|
|
67
|
+
#### 📦 [`hoangnb24/skills`](https://github.com/hoangnb24/skills)
|
|
68
|
+
|
|
69
|
+
**Why it matters:**
|
|
70
|
+
|
|
71
|
+
- Workflow-first skill design with a router that decides what to load next
|
|
72
|
+
- Explicit output contracts and references stored alongside each skill
|
|
73
|
+
|
|
74
|
+
**Patterns adopted here:**
|
|
75
|
+
|
|
76
|
+
- 🔹 Router skill (`using-skills`) as the entry point
|
|
77
|
+
- 🔹 Output templates in `references/`
|
|
78
|
+
- 🔹 Related skills graph for navigation
|
|
79
|
+
|
|
80
|
+
### 🏆 Ranked Patterns To Keep
|
|
81
|
+
|
|
82
|
+
| # | Pattern |
|
|
83
|
+
|---|---|
|
|
84
|
+
| 1️⃣ | Separate brainstorming from planning when the request is vague |
|
|
85
|
+
| 2️⃣ | Separate planning from execution for non-trivial changes |
|
|
86
|
+
| 3️⃣ | Require verification evidence before completion claims |
|
|
87
|
+
| 4️⃣ | Keep skills portable and self-contained |
|
|
88
|
+
| 5️⃣ | Keep knowledge separate from workflows |
|
|
89
|
+
| 6️⃣ | Generate adapter output from one source of truth |
|
|
90
|
+
|
|
91
|
+
### ⏳ Patterns Deferred For Later
|
|
92
|
+
|
|
93
|
+
- 📦 Full plugin packaging
|
|
94
|
+
- ⚙️ Hook runtime and automation
|
|
95
|
+
- 📋 Machine-readable skill manifests
|
|
96
|
+
- 🧪 Skill-triggering tests
|
|
97
|
+
- 🔌 MCP or CLI bridge
|
|
98
|
+
|
|
99
|
+
> 💡 These are good future upgrades, but they are intentionally out of scope for the current lightweight version.
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
# 🎯 Skill Spec
|
|
2
|
+
|
|
3
|
+
> 🇻🇳 **[Tiếng Việt](../i18n/skill-spec.vi.md)**
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
### 📁 Required Layout
|
|
8
|
+
|
|
9
|
+
Every skill lives in its own directory under `skills/`.
|
|
10
|
+
|
|
11
|
+
```text
|
|
12
|
+
skills/<skill-name>/
|
|
13
|
+
├─ 📄 meta.yaml
|
|
14
|
+
├─ 📖 SKILL.md
|
|
15
|
+
├─ 💡 examples.md
|
|
16
|
+
└─ 📂 references/
|
|
17
|
+
└─ <supporting-file>.md
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
### 📄 Required Files
|
|
21
|
+
|
|
22
|
+
#### `meta.yaml`
|
|
23
|
+
|
|
24
|
+
Use this file for stable metadata that scripts or future tooling can read.
|
|
25
|
+
|
|
26
|
+
**Required keys:**
|
|
27
|
+
|
|
28
|
+
| Key | Purpose |
|
|
29
|
+
|---|---|
|
|
30
|
+
| `name` | Skill identifier |
|
|
31
|
+
| `version` | Semantic version |
|
|
32
|
+
| `category` | Skill category |
|
|
33
|
+
| `summary` | One-line description |
|
|
34
|
+
|
|
35
|
+
**Recommended keys:**
|
|
36
|
+
|
|
37
|
+
| Key | Purpose |
|
|
38
|
+
|---|---|
|
|
39
|
+
| `triggers` | When to activate |
|
|
40
|
+
| `inputs` | What the skill needs |
|
|
41
|
+
| `outputs` | What the skill produces |
|
|
42
|
+
| `constraints` | Guardrails |
|
|
43
|
+
| `related_skills` | Connected skills |
|
|
44
|
+
|
|
45
|
+
#### `SKILL.md`
|
|
46
|
+
|
|
47
|
+
The main instruction file. Keep it focused and operational.
|
|
48
|
+
|
|
49
|
+
**Recommended sections:**
|
|
50
|
+
|
|
51
|
+
- 🎯 Purpose
|
|
52
|
+
- ⏰ When to use
|
|
53
|
+
- 🔄 Workflow
|
|
54
|
+
- 📋 Output format
|
|
55
|
+
- 🚩 Red flags
|
|
56
|
+
- ✅ Done criteria
|
|
57
|
+
|
|
58
|
+
**Strongly recommended when relevant:**
|
|
59
|
+
|
|
60
|
+
- 🧭 Activation rule or routing hint
|
|
61
|
+
- ✅ Verification gate
|
|
62
|
+
- ➡️ Handoff to the next skill
|
|
63
|
+
|
|
64
|
+
#### `examples.md`
|
|
65
|
+
|
|
66
|
+
Show at least one realistic input and the expected style of response or behavior.
|
|
67
|
+
|
|
68
|
+
#### `references/`
|
|
69
|
+
|
|
70
|
+
Use this for supporting artifacts:
|
|
71
|
+
|
|
72
|
+
- 📋 Output templates
|
|
73
|
+
- ☑️ Checklists
|
|
74
|
+
- 📊 Rubrics
|
|
75
|
+
- 🌳 Decision trees
|
|
76
|
+
|
|
77
|
+
> ⚠️ Do not move the main workflow into `references/`. The main behavior should stay in `SKILL.md`.
|
|
78
|
+
|
|
79
|
+
### ✍️ Authoring Rules
|
|
80
|
+
|
|
81
|
+
- 🔹 Keep the skill narrow enough that an agent can decide when to use it
|
|
82
|
+
- 🔹 Optimize for reuse, not for one-off project details
|
|
83
|
+
- 🔹 Prefer portable instructions over vendor-specific syntax
|
|
84
|
+
- 🔹 Avoid hidden assumptions about tools, frameworks, or directory names
|
|
85
|
+
- 🔹 Ask one short blocking question when needed instead of writing around ambiguity
|
|
86
|
+
- 🔹 If the skill changes code or task state, be clear about what evidence counts as done
|
|
87
|
+
|
|
88
|
+
### ✅ Quality Bar
|
|
89
|
+
|
|
90
|
+
A skill is good enough to keep when it:
|
|
91
|
+
|
|
92
|
+
| | Criteria |
|
|
93
|
+
|---|---|
|
|
94
|
+
| 🎯 | Has a clear trigger |
|
|
95
|
+
| 🔄 | Has a repeatable workflow |
|
|
96
|
+
| 📋 | Gives a stable output shape |
|
|
97
|
+
| 🛡️ | Helps the agent avoid a common failure mode |
|
|
98
|
+
| 💡 | Includes an example grounded in reality |
|
|
99
|
+
| ➡️ | Makes it obvious what should happen next |
|
|
100
|
+
|
|
101
|
+
### 🚫 Anti-Patterns
|
|
102
|
+
|
|
103
|
+
- ❌ Skills that try to solve every task at once
|
|
104
|
+
- ❌ Vague prompts such as "be a great engineer"
|
|
105
|
+
- ❌ Long theory with no operational steps
|
|
106
|
+
- ❌ Hard-coded assumptions about one agent platform
|
|
107
|
+
- ❌ Embedding secrets, user-specific tokens, or machine paths
|