11---
22title : Writing plugin skills
3- description : Design, author, validate, and maintain thin PSModule plugin skills that point to shared documentation .
3+ description : Create and maintain plugin skills with agent-specific instructions and links to shared guidance .
44---
55
66# Writing plugin skills
77
8- Use this guide when creating or changing a skill in the PSModule plugin. A
9- skill is an operational entry point for an agent; shared process and policy
10- belongs in the documentation structure so people and agents can use the same
11- source of truth.
8+ Use this guide to create or change a skill in the PSModule plugin.
9+ A skill is an agent's entry point. Shared process and policy belong in the
10+ documentation, where people and agents use the same source.
1211
1312## Keep skills thin
1413
15- Put common explanations, repository policy, standards, and user-facing
14+ Put shared explanations, repository policy, standards, and user-facing
1615procedures in the appropriate ` docs/content/ ` page. Keep ` SKILL.md ` focused on
1716the agent-specific information needed to apply that guidance:
1817
19- - when the skill should be used and when it should not;
20- - the agent's operating sequence and required handoffs;
21- - explicit stop conditions and escalation boundaries;
18+ - when the skill should be used and when it should not.
19+ - the agent's operating sequence and required handoffs.
20+ - explicit stop conditions and escalation boundaries.
2221- the repository-specific validation and report-back contract.
2322
24- The skill should link to the shared guide near its beginning . Do not copy
23+ The skill should link to the shared guide near its start . Do not copy
2524organization-wide MSX rules, module standards, or long tutorials into the
2625skill. Link to the canonical source instead.
2726
@@ -36,54 +35,56 @@ Create one directory per skill:
3635
3736Use lowercase, descriptive, hyphen-separated identifiers. Start ` SKILL.md `
3837with front matter containing the matching ` name ` and a concise ` description ` .
39- The description should make the skill discoverable without embedding the full
40- procedure.
38+ The description should identify when to use the skill without the full procedure.
4139
4240After the front matter, include:
4341
44- 1 . a short purpose statement and the link to the shared documentation;
45- 2 . agent-specific operating instructions;
46- 3 . explicit stop conditions;
47- 4 . references to related repository and canonical MSX guidance.
42+ 1 . State the purpose. Link to the shared documentation.
43+ 2 . Add agent-specific operating instructions.
44+ 3 . State explicit stop conditions.
45+ 4 . Link to related repository and canonical MSX guidance.
4846
49- Prefer short imperative instructions, checklists, and handoff fields over
50- background material . Do not include stale vendor-specific model recommendations
51- or obsolete tool instructions . If a procedure changes for both users and
52- agents, update the documentation guide first and reduce the skill to a pointer
53- plus the remaining agent contract .
47+ Prefer short imperative instructions, checklists, and handoff fields to
48+ background explanations . Do not include model recommendations or tool
49+ instructions that no longer apply . If a procedure changes for both users and
50+ agents, update the documentation guide first. Then reduce the skill to a link
51+ and the remaining agent-specific instructions .
5452
5553## Plugin integration
5654
57- Inspect the existing plugin before editing . Preserve its ` plugin.json `
58- metadata and directory conventions. Add the new skill to the plugin README's
55+ Before you edit, examine the existing plugin. Preserve its ` plugin.json `
56+ metadata and directory conventions. Add the skill to the plugin README's
5957discoverability list with a repository-relative link. Do not add a second
6058manifest or duplicate marketplace registration for an individual skill.
6159
6260Keep the skill's scope explicit. If it coordinates child sessions or other
63- agents, define the parent owner, child boundary, expected handoff, validation,
64- report-back, and stop conditions. Do not silently broaden a skill into
65- unrelated repository work.
61+ agents, define the parent owner and each child's scope.
62+ Specify handoffs, validation, completion reports, and stop conditions.
63+ Do not broaden a skill into unrelated repository work without an explicit scope decision .
6664
6765## Validation
6866
6967Run the smallest existing checks that cover the changed surfaces:
7068
71- - ` git diff --check ` ;
72- - repository Markdown and natural-language lint when available;
73- - plugin and marketplace metadata parsing;
69+ - ` git diff --check ` .
70+ - repository Markdown and natural-language lint when available.
71+ - plugin and marketplace metadata parsing.
7472- ` zensical build --clean ` when documentation or navigation changes.
7573
76- Review every relative link from the skill and guide, the final plugin README
77- entry, and the diff for duplicated policy, stale instructions, accidental
78- generated files, or unrelated changes. Report the draft PR URL, files changed,
79- validation outcomes, policy decisions, and blockers to the owning session.
74+ Review every relative link from the skill and guide. Make sure that the plugin
75+ README entry identifies the skill and links to it.
76+ Examine the diff for duplicate policy, outdated instructions, generated files,
77+ or unrelated changes.
78+ Report the draft PR URL, changed files, validation results, policy decisions,
79+ and blockers to the owning session.
8080
8181## Maintenance rule
8282
83- When shared process changes, update the documentation page and its navigation,
84- then make each dependent skill point to the revised source. When only an
85- agent-specific trigger, handoff, stop condition, or tool boundary changes,
86- update the skill without duplicating the common documentation.
83+ When shared process changes, update the documentation page and its navigation.
84+ Then make each dependent skill link to the revised source.
85+ When only the agent contract changes, update the skill. Agent-specific changes
86+ include triggers, handoffs, stop conditions, and tool boundaries.
87+ Do not duplicate shared documentation.
8788
8889## References
8990
0 commit comments