Content
80%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.
The content is highly concise and fully actionable with copy-paste ast-grep commands, but workflow clarity is capped because the batch '--rewrite' refactor path lacks an explicit validate-before-apply checkpoint, and progressive disclosure is weakened by references to bundle files that do not exist.
Suggestions
Add an explicit validation checkpoint to the refactoring workflow: after the preview (#8), instruct to review the diff and only run '--rewrite' (#9) once the preview is confirmed correct, forming a validate-then-apply feedback loop.
Create the referenced bundle files (references/js-ts-patterns.md, python-patterns.md, go-rust-patterns.md, security-patterns.md, advanced-usage.md, and assets/rule-template.yaml) so the 'Additional Resources' links resolve, or remove the links.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The body is lean tables of patterns and commands with no concept padding ('Pattern Syntax', 'Top 10 Essential Patterns', 'Quick Reference'); it assumes Claude knows AST concepts and every token earns its place. Not a 4 because there is no noticeable over-explanation to trim. | 5 / 5 |
Actionability | Quotes like 'sg -p \"console.log($_)\"', 'sg -p \"var $NAME = $_\" -r \"const $NAME = $_\" --rewrite' are copy-paste ready executable commands covering the common search and refactor cases. Not a 4 because the examples are fully executable and span the common cases. | 5 / 5 |
Workflow Clarity | Item #9 'Apply refactoring' with '--rewrite' is a batch/destructive operation and #8 'Preview refactoring' exists but there is no explicit validation checkpoint (e.g. review preview then apply only when correct), so per the rubric the destructive/batch cap of 3 applies. Not a 4 because the missing explicit validate-then-apply feedback loop triggers the cap; not a 2 because a rough preview/apply sequence is present. | 3 / 5 |
Progressive Disclosure | The body signals one-level-deep references ('./references/js-ts-patterns.md' ... './assets/rule-template.yaml') under 'Additional Resources', but those bundle files do not exist in references/ or assets/, so the navigation does not resolve. Not a 4 because the referenced files are missing, which undermines clear navigation; not a 2 because the in-body structure itself is well organized with clearly signaled reference paths. | 3 / 5 |
Total | 16 / 20 Passed |