You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: plugins/agentic-engineering/skills/agent-plugin-review/references/skill-quality-checklist.md
+12Lines changed: 12 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,6 +56,14 @@ description: Use when tests have race conditions, timing dependencies, or pass/f
56
56
- [ ] Move heavy reference (100+ lines) to separate files
57
57
- [ ] Use cross-references instead of repeating content from other skills
58
58
- [ ] Compress examples — one excellent example beats many mediocre ones
59
+
- [ ] When SKILL.md exceeds ~500 words for a standard skill, the heaviest section is almost always inlined reference material — extract it
60
+
61
+
### Coverage Contracts vs. Rule Restatement
62
+
63
+
When a skill author wants to enforce that the agent doesn't skip rules, the temptation is to inline each rule with its full rationale. Don't.
64
+
65
+
- **Coverage contract pattern:** Keep one-line checklist items in SKILL.md naming each rule and citing the reference file (e.g., `"Lifecycle choice — apply large-table rule in references/schema-rules.md"`). Add one sentence: "Silence on any item is itself a review gap." Close the silent-skip loophole with: "If a reference file is unavailable, say so explicitly rather than skipping it."
66
+
- **Anti-pattern:** Multi-paragraph items that restate rules and rationale already in `references/`. The fix is structural — the prose is in the wrong file, not the wrong shape. Move operational procedures (how to locate files, `find` syntax, what to record) and output-format meta (citation discipline worked examples) into `references/`. Mark that file as always-load.
59
67
60
68
### Structure
61
69
@@ -115,6 +123,8 @@ Match specificity to the task's fragility:
115
123
| Version printing instructions | Fragile, rely on git history |
116
124
| Hardcoded local paths | Machine-specific, not portable |
117
125
| Description summarizes workflow | the agent follows description, skips SKILL.md body |
126
+
| SKILL.md inlines rule prose that also lives in `references/` | Two sources of truth — the inline copy drifts from the canonical reference; agent applies the SKILL.md version and ignores the more detailed reference |
127
+
| SKILL.md embeds operational procedures or worked-example pairs | Procedures (how to locate files, `find` syntax, what to record) and output-format meta (citation discipline examples) belong in `references/` per progressive disclosure |
@@ -125,3 +135,5 @@ For skills that enforce rules (TDD, verification, coding standards):
125
135
- [ ] Red flags list for self-checking
126
136
- [ ] "Spirit vs letter" addressed: "Violating the letter IS violating the spirit"
127
137
- [ ] Hard gates at critical decision points
138
+
- [ ] Discipline patterns (output-format meta, citation examples, verification procedures) live in `references/` — SKILL.md names them in one line and cites the file
139
+
- [ ] Discipline reference file is marked as always-load so the agent cannot bypass it (don't inline to guarantee coverage — mark as unmissable instead)
0 commit comments