Content
75%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 body is an exceptionally actionable and token-efficient conventions guide with tight GOOD/BAD code examples throughout. Its one serious defect is that all five referenced companion files are missing from the bundle, making the otherwise well-structured progressive-disclosure layer unusable.
Suggestions
Ship the five referenced files (clickhouse.md, mysql.md, testing.md, migrations.md, permissions.md) in a references/ directory, or remove the "Reference Files" section if they cannot be bundled.
Consider moving the extended SQL-construction walkthrough (the multi-example tokenUsageNames case) into a reference file once the bundle exists, keeping only the rule table and one example inline.
Add a short "when in doubt" checklist or validation step (e.g. grep for `new ST(` or string-concatenated SQL before finishing a change) to give the gotchas section a verification checkpoint.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The body is a dense rule-plus-snippet reference with essentially no explanation of concepts Claude already knows; every section is a terse convention followed by GOOD/BAD examples. It misses anchor 5 only because a few rationale sentences (logging greppability, SQL interpolation "Why:") could be trimmed slightly. | 4 / 5 |
Actionability | Every convention ships copy-paste-ready Java with exact annotations (`@Builder(toBuilder = true)`, `@RequiredArgsConstructor(onConstructor_ = @Inject)`) and explicit GOOD/BAD contrasts, including StringTemplate `<if(...)>` syntax and named builder classes. This matches anchor 5: executable, specific examples covering the common cases. | 5 / 5 |
Workflow Clarity | This is a declarative conventions reference rather than a multi-step process skill, and its sections (Architecture, Naming, Lombok, Gotchas, API, Errors, Logging) are clearly organized and unambiguous. It does not reach anchor 5 because no checklists or validation checkpoints exist, and no multi-step workflow with feedback loops is articulated. | 4 / 5 |
Progressive Disclosure | The "Reference Files" section clearly signals five one-level-deep links (clickhouse.md, mysql.md, testing.md, migrations.md, permissions.md), but none of these files exist in the bundle — no references/, scripts/, or assets/ directories are present at all. Navigation to every advanced topic is broken, matching anchor 2; the inlined content itself is appropriately core. | 2 / 5 |
Total | 15 / 20 Passed |