Content
92%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.
A tightly written, highly actionable authoring guide: complete executable code for a full component lifecycle, a coherent build sequence with validation checkpoints and a symptom-based recovery table, and clean one-level-deep reference splitting. The only weakness is mild redundancy where the boundary rules appear in three forms (rules list, mistakes table, checklist).
Suggestions
Consolidate the overlap between Boundary rules and Common mistakes: keep the mistakes table rows that add a symptom or failure mode (e.g. 'Always returns no user') and drop rows that merely restate a rule already listed.
The closing Checklist repeats boundary rules a third time; consider trimming it to verification-only items (dev runs clean, reference paths match, tested through the example app) to cut roughly 10 lines.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The body is dense and domain-specific with no generic padding (it never explains what Convex or TypeScript is; every line is component-specific), but the boundary rules are stated three times — in the intro ("a component cannot read the parent's tables, ctx.auth, or process.env"), the Boundary rules section, and again across the Common mistakes table and Checklist. The repetition is functional (rules, symptom lookup, checklist) but the overlap between the mistakes table and boundary rules is a genuine trimming opportunity. | 4 / 5 |
Actionability | Every stage ships complete, copy-paste-ready TypeScript: defineComponent, defineSchema with an index, fully validated mutation/query handlers, parent registration with app.use, a typed client wrapper class using Pick ctx types, and authenticated app-side wrappers. Concrete commands (npx convex dev, npx convex codegen), a folder layout, and edge cases (local-only components, a second named instance) are all covered. | 5 / 5 |
Workflow Clarity | The sections follow the actual build order (component vs helper decision → folder layout → config → schema → functions → register → npx convex dev → client wrapper), with an explicit validation checkpoint after registration ("Run npx convex dev. It generates components.counter...") and a closing 10-item checklist including "npx convex dev runs clean" and "Tested through an example app". The Common mistakes table is a symptom → cause → fix feedback loop for error recovery, matching the top anchor. | 5 / 5 |
Progressive Disclosure | The core authoring workflow lives inline while npm publishing detail (exports map, build order, versioning) is split into a real, substantive references/publishing.md that is clearly signaled with a conditional open-trigger: "open it when the component will be installed from a package rather than a local folder." References are one level deep; the assets/ folder holds only non-navigational logo files; section headers make navigation easy. | 5 / 5 |
Total | 19 / 20 Passed |