Content
60%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.
Highly actionable content with strong, well-gated workflows, but it is token-heavy: a massive inlined API reference and repeated deploy disclaimers violate both conciseness and progressive-disclosure principles. Moving the API reference into a separate file would address the two lowest dimensions at once.
Suggestions
Move the ~620-line 'TypeScript SDK (windmill-client)' API reference into a separate file (e.g. references/windmill-client-api.md) and replace it with a one-line pointer plus the handful of most-used helpers; this fixes progressive disclosure and sharply cuts conciseness cost.
State the 'only deploy when the user explicitly asks to deploy/publish/push' rule once in the Deploying section and reference it from the other sections instead of restating it four times (lines 15, 19, 26, 45).
Tighten 'Keep metadata in sync after editing': it currently re-explains the hash-drift mechanism and the offer-vs-run-silently guidance twice; collapse to a single crisp edit→generate-metadata→diff→report sequence.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | Noticeably verbose: the same deploy-only-when-explicitly-asked rule is restated four times (lines 15, 19, 26, 45) and the 'Keep metadata in sync' prose repeats its points, plus a ~620-line inlined API reference consumes the token budget — padding that could be tightened or moved out. Not a 1 because the prose is not patronizing and the API block is compact signatures rather than concept explanation. | 2 / 5 |
Actionability | Fully executable guidance throughout: copy-paste main/resource/import/preprocessor/S3 code samples, concrete commands (`wmill script preview`, `generate-metadata --dry-run`, `generate-metadata rehash`, `resource-type list --schema`), and exact function signatures covering the common cases. No pseudocode or vague direction. | 5 / 5 |
Workflow Clarity | Clear sequences with real checkpoints — the metadata flow offers a `--dry-run` inspection step, a diff-and-report step to catch unwanted version bumps before deploying, and explicit gating that deploying requires an explicit user request. Stays at 4 rather than 5 because these validations are distributed across prose sections rather than staged as one explicitly-marked validate→fix→retry checklist, and the destructive-deploy guard is stated as a rule rather than a numbered validation step. | 4 / 5 |
Progressive Disclosure | No bundle/reference files exist at all, and the ~620-line windmill-client API reference (lines 174-793) is inlined directly into SKILL.md — the textbook 'content that clearly belongs in separate files is inlined' case. Section headers keep it above a 1, but the complete absence of any one-level-deep reference split leaves it below a 3. | 2 / 5 |
Total | 13 / 20 Passed |