Skip to content

Commit 11449ae

Browse files
authored
Add domain-specific vs universal content guidelines (#777)
1 parent fd264b0 commit 11449ae

2 files changed

Lines changed: 9 additions & 6 deletions

File tree

plugins/agentic-engineering/skills/agent-plugin-review/SKILL.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ For each SKILL.md, check against `references/skill-quality-checklist.md`:
4545
- Description starts with "Use when..." and describes triggering conditions only (not workflow)
4646
- Description does NOT summarize the skill's process — this causes agents to follow the description instead of reading the SKILL.md body
4747
- Body is concise — only include what the agent doesn't already know
48+
- Content is domain-specific (internal conventions, business patterns, context for WHY) — universal concepts AI agents already know are excluded
4849
- Imperative/infinitive form, not second person
4950
- Heavy reference (100+ lines) moved to `references/` files
5051
- One excellent code example beats many mediocre ones

plugins/agentic-engineering/skills/agent-plugin-review/references/skill-quality-checklist.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ Derived from [Superpowers writing-skills](https://github.com/obra/superpowers/)
1414

1515
### Why description must not summarize workflow
1616

17-
Testing revealed that when a description summarizes the skill's workflow, Claude may follow the description instead of reading the full SKILL.md content. A description saying "code review between tasks" caused Claude to do ONE review, even though the SKILL.md flowchart clearly showed TWO reviews. When the description was changed to just triggering conditions, Claude correctly read and followed the full skill.
17+
Testing revealed that when a description summarizes the skill's workflow, the agent may follow the description instead of reading the full SKILL.md content. A description saying "code review between tasks" caused the agent to do ONE review, even though the SKILL.md flowchart clearly showed TWO reviews. When the description was changed to just triggering conditions, the agent correctly read and followed the full skill.
1818

1919
### Description examples
2020

2121
```yaml
22-
# BAD: Summarizes workflow - Claude may follow this instead of reading skill
22+
# BAD: Summarizes workflow - the agent may follow this instead of reading skill
2323
description: Use when executing plans - dispatches subagent per task with code review between tasks
2424

2525
# BAD: Too much process detail
@@ -43,10 +43,12 @@ description: Use when tests have race conditions, timing dependencies, or pass/f
4343
4444
## Content Quality
4545
46-
### Conciseness (Claude Search Optimization)
46+
### Conciseness (Agent Search Optimization)
4747
48-
- [ ] SKILL.md body is concise — only include what Claude doesn't already know
49-
- [ ] Challenge each paragraph: "Does Claude really need this explanation?"
48+
- [ ] SKILL.md body is concise — only include what the agent doesn't already know
49+
- [ ] Content is domain-specific: technology preferences, internal conventions, business domain patterns, industry constraints, context explaining WHY rules exist
50+
- [ ] Universal concepts excluded: standard programming principles (SOLID, DRY, etc.), obvious examples, verbose explanations, best practices AI agents already know
51+
- [ ] Challenge each paragraph: "Does the agent really need this explanation?"
5052
- [ ] Target word counts:
5153
- Frequently-loaded skills: < 200 words
5254
- Standard skills: < 500 words
@@ -112,7 +114,7 @@ Match specificity to the task's fragility:
112114
| Generic labels (helper1, step2) | No semantic meaning |
113115
| Version printing instructions | Fragile, rely on git history |
114116
| Hardcoded local paths | Machine-specific, not portable |
115-
| Description summarizes workflow | Claude follows description, skips SKILL.md body |
117+
| Description summarizes workflow | the agent follows description, skips SKILL.md body |
116118

117119
## Discipline-Enforcing Skills (Additional Checks)
118120

0 commit comments

Comments
 (0)