Content
90%Weight 40%Scale 1-5Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.
An excellent conventions skill: dense, example-driven, and free of filler, with concrete executable snippets and explicit do/don't rules for every documented construct. The only notable gaps are validation guidance limited to the xref section and a single ~200-line file where a one-level-deep reference split could improve progressive disclosure.
Suggestions
Add a brief verify step for the other edit types (e.g. run the docs build or yarn crocodocs:generate after front-matter, image, or code-example changes), mirroring the xref verification guidance.
Consider splitting the three linking-form rule lists (reST roles, xrefs, Markdown links) into a references/ file, keeping SKILL.md as a shorter overview with one-level-deep pointers.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The body is lean and dense: every section is rules plus a short verifiable example, with no padding and no explanation of concepts Claude already knows (no 'what Markdown is', no library intros). Even the comparative 'When to prefer over the other forms' bullets state only decision-relevant deltas. This matches the 'every token earns its place' anchor. | 5 / 5 |
Actionability | Guidance is copy-paste ready throughout: executable reST-role and xref snippets, Markdown-link examples, docstring admonition samples, front-matter YAML, `<Image>`/`<CodeExample>` JSX with import lines, sidebar YAML, and the concrete regeneration command 'cd website && yarn crocodocs:generate'. The 'Rules' and 'Not supported' lists resolve the common ambiguity cases (qualified vs local refs, no parens in targets, custom labels unsupported). | 5 / 5 |
Workflow Clarity | Each task is presented as an unambiguous single action, and the sidebar section has a clear two-step sequence (edit sidebars.yml → regenerate with yarn crocodocs:generate); the xref section also supplies a verification checkpoint ('verify with a build or yarn crocodocs:generate'). It falls short of a 5 because validation guidance is only stated for xrefs — image, code-example, and front-matter edits get no equivalent verify step, and there is no error-recovery loop. | 4 / 5 |
Progressive Disclosure | The body is well organized into clearly headed, self-contained sections (docstrings, reST roles, xrefs, Markdown links, admonitions, front matter, images, code examples, inline HTML, sidebars) with no nested or buried references and no monolithic wall of text. Since no bundle files exist and the content is a coherent conventions reference of moderate length, inline placement is defensible; it does not reach a 5 because the rules tables for the three linking forms are lengthy enough that a references/ split (e.g. a linking-formats detail file) would keep the overview even leaner. | 4 / 5 |
Total | 18 / 20 Passed |