Content
78%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 a detailed, highly actionable reference with concrete code, clear sequenced workflows, and real validation safeguards for destructive operations. Its main weaknesses are a monolithic single-file structure that inlines content the doc itself says belongs in a companion guide, and some repeated emphasis that could be tightened.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The body is high-signal Windmill-specific content with executable commands and code rather than concepts Claude already knows, fitting the score-4 anchor "Efficient; minor instances of over-explanation that could be trimmed"; it is not 5 because the 'YOU run it, don't tell the user' message and `wmill generate-metadata` guidance are repeated across the intro, steps, anti-patterns, and CLI sections, and it is not 3 because the bulk of the prose earns its place. | 4 / 5 |
Actionability | The guide is packed with copy-paste-ready, executable guidance — the `wmill app new` flag invocation, TypeScript/Python runnable examples, YAML configs, parameterized SQL queries, and the `backend`/`backendAsync`/`waitJob` binding table — covering the common cases, matching the score-5 anchor "Fully executable; copy-paste ready code or commands; specific examples cover the common cases." | 5 / 5 |
Workflow Clarity | The 'Creating a Raw App' workflow is explicitly sequenced (Step 1 gather → Step 2 run → Step 3 offer preview) with an input-validation feedback loop ("If the user replies with something ambiguous, ask again rather than guessing"), an anti-patterns checklist, and destructive-op safeguards (non-interactive mode aborts without `--overwrite`; idempotent SQL; whitelist-after-creation), matching the score-4 anchor; it is not 5 because the SQL-migration and sync workflows lean on a browser modal or user action rather than an explicit Claude-driven validate→fix→retry loop. | 4 / 5 |
Progressive Disclosure | The file has clear section headers and tables (good structure) but is a single ~460-line monolith with no bundle files and no one-level-deep references, and the intro states the platform-shape material "is covered in the companion authoring guide" yet that material is inlined in the second `# Windmill Raw Apps` section — fitting the score-3 anchor "Some structure but could be better organized; ... content that should be separate is inline"; it is not 2 because structure is real and well-organized, not minimal, and not 4 because no content is split out into separate referenced files. | 3 / 5 |
Total | 16 / 20 Passed |