Content
77%Weight 40%Scale 1-3Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.
The body is a lean, well-sequenced sharding runbook with real SQL and explicit validation plus an error-recovery table. Its gaps are actionability (several steps name tools without executable detail) and progressive disclosure (the body ignores the bundle, whose scripts are mostly missing or stubs).
Suggestions
Add executable detail to the abstract steps — e.g., a sample Citus/Vitess routing config snippet, a concrete hash-routing function, or a mongos connect example — so guidance is copy-paste ready rather than tool-naming.
Wire the body to the bundle: link the actual scripts (init_sharding.py, and create the missing rebalance_shards.py / cross_shard_query.py / validate_sharding_config.py) from the relevant steps, and move the per-database tool guidance or error-handling table into references/ with one-level-deep links.
Replace or remove the stub init_sharding.py (currently a generic project scaffolder that does no sharding) so the referenced bundle file actually supports the workflow.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The body is lean and operational — it never explains concepts Claude already knows (no 'sharding is...' preamble) and every section (prerequisites, SQL-embedded steps, error table) earns its place. It is not a 2 because there is no unnecessary explanation or padding to tighten, matching the 'lean and efficient; assumes Claude's competence' anchor. | 3 / 3 |
Actionability | Some steps give concrete executable SQL (`SELECT pg_size_pretty(pg_total_relation_size(...))`, `sh.enableSharding()`) and batch sizes, but others only name tools without executable detail ('configure vitess or ProxySQL routing', 'use Citus extension', 'Implement the routing layer'). It is not a 1 because real commands are present, and not a 3 because guidance is incomplete and not copy-paste ready across the workflow. | 2 / 3 |
Workflow Clarity | A clear 10-step sequence carries explicit validation checkpoints ('Verify row counts match after migration', 'verify with checksums', 'Validate cross-shard queries work correctly') plus a dedicated error-handling table for recovery. It is not a 2 because validation is present (the missing-validation cap does not apply), and the error table supplies feedback loops for the destructive/batch operations. | 3 / 3 |
Progressive Disclosure | The body is well-sectioned but monolithic — it references none of the bundle files, and the bundle itself is weak: scripts/README lists 4 scripts of which only init_sharding.py exists (an unrelated scaffolding stub) and the other 3 are missing; references/ and assets/ hold only placeholder READMEs. It is not a 1 because sections are organized, and not a 3 because no well-signaled one-level-deep references connect the body to the bundle. | 2 / 3 |
Total | 10 / 12 Passed |