feat(skill-maker): add XML structure guidance and update examples#28
Merged
Conversation
Agents parse XML tags more reliably than markdown headings for skills with multiple semantic sections. Based on prompting best practices and the pattern already used by 6 of 7 skills in this repo. - Add references/xml-structure-guide.md with tag vocabulary and patterns - Add templates/router-skill-xml.md as XML-based starter template - Update SKILL.md to recommend XML for router/domain skills - Update audit and review checklists with XML consistency checks - Replace markdown-only router example with XML intake/routing example
…ocabulary - Rename 'Established tag vocabulary' to 'Suggested tag patterns' - Reframe tags as patterns that have worked well, not a closed set - Encourage inventing new tags when existing ones don't fit - Soften audit/review checklists from requirements to considerations - Clarify when XML helps vs when markdown is enough - skill-maker itself stays markdown — sequential instructional content
Practice what we preach — skill-maker has three distinct entry points (audit, create, consolidate) and 8 reference files scattered as inline pointers. Add XML structure where it helps: - <intake> for the top-level mode selection - <routing> mapping responses to workflows - <reference_index> consolidating all reference file pointers Phases 1-5 stay as markdown headings — sequential instructional content where order matters more than section lookup.
- architecture-patterns.md: router structure lists XML tags, router table and routing rules examples use <intake>/<routing> instead of markdown - anti-patterns.md: missing intake question fix shows <intake> example - spec-guide.md: body section shows XML structure example with <essential_principles>, <intake>, <routing>
- xml-structure-guide.md: replace skill-specific paths (to-issue.md, refine.md, auth.md) with generic placeholders (command-a.md, setup.md) so agents don't confuse examples with real local files - SKILL.md: replace vague 'Follow ... below' routing targets with specific section names and file paths
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Agents parse XML tags more reliably than markdown headings for skills with multiple semantic sections. This updates skill-maker to recommend and demonstrate XML structure throughout.
Changes
New files:
references/xml-structure-guide.md— suggested tag patterns, when to use XML vs markdown, anti-patternstemplates/router-skill-xml.md— XML-based starter template for router skillsSKILL.md updates:
<intake>,<routing>,<reference_index>tags (practices what it preaches)Reference file updates:
architecture-patterns.md— router structure section lists XML tags, router table example uses<intake>/<routing>anti-patterns.md— missing intake question fix shows<intake>examplespec-guide.md— body section shows XML structure exampleAudit fixes:
xml-structure-guide.mdexamples use generic placeholder paths instead of paths from sibling skillsSKILL.mdrouting table uses specific section names instead of vague "follow below"Design decisions