Content
65%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 commendably lean and provides concrete, executable commands with a clear validation vocabulary (dry-run, check, exit codes). Its weaknesses are structural: no explicit ordered workflow, a referenced settings example file absent from the bundle, and dense unsectioned paragraphs that mix operation, configuration, and dependency housekeeping.
Suggestions
Present an explicit ordered workflow (e.g. numbered steps: set GITHUB_STANDARD_CHECK_LOCATION → adopt --dry-run → adopt → render → check) so the prerequisite precedes the commands.
Ship or fix the link to kendex.settings.toml.example, since the body's "[settings example]" pointer resolves to no file in the bundle.
Add section headings (e.g. Commands, Configuration, Dependencies) to break up the five dense unstructured paragraphs, and trim non-operational notes like the KEN-2362 transition and catalog release policy into a maintenance section.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The body is dense and lean with no padding or explanation of known concepts ("Exit codes: 0 clean, 1 findings, 2 could not complete"), but includes minor non-operational housekeeping such as the "KEN-2362" transition note and catalog release policy that could be trimmed. | 4 / 5 |
Actionability | Four copy-paste-ready commands are given along with concrete behavior contracts ("adopt --dry-run" preview, exit codes, "--help"), but key operational detail is delegated to external files and the prerequisite setting is described only in prose, leaving minor gaps. | 4 / 5 |
Workflow Clarity | The intended sequence (choose GITHUB_STANDARD_CHECK_LOCATION, preview with adopt --dry-run, adopt via bot-instructions, render, check) exists only implicitly across scattered paragraphs, with the prerequisite stated after the commands; validation tools exist (dry-run, exit codes, check --staged) but are not wired into an explicit ordered workflow. | 3 / 5 |
Progressive Disclosure | References are one level deep and clearly signaled, and the referenced script exists, but "kendex.settings.toml.example" is missing from the bundle, several links point to external packages, and the body's ~25 dense lines carry only two headings with no sectioning of operational, configuration, and dependency content. | 3 / 5 |
Total | 14 / 20 Passed |