AC better-readme
Use when the user asks to create, improve, fix, or audit a README.md file, score their README, document an open source project, or set up new project docs. Provides 8-dimension 0-100 quality scoring, 5-type template matrix (Library, CLI, App, Skill, Data), and pre-publish checklist. Do NOT use for API docs, wikis, inline code comments, or general technical writing.
md file, score their README, document an open source project, or set up new project docs.
As a process C 56/100 · Has gaps — weak spots: result and completion, inputs and preconditions, running it twice
How to improve
- Your own cases (evals/evals.json, 4–6 real requests with expected answers): the full check would then run those instead of a model-drafted suite.
- A spec.yaml with trigger phrases and assertions — a behaviour contract for CI; `skilltest init` writes a template.
Guard findings · 0
✓ No critical or high findings
Files scanned: 8. Evidence is masked. Grey chips explain why severity was lowered.
Against the Agent Skills spec
✓ No remarks against the Agent Skills spec
Process rating: all ten parameters 56/100
- 0Result and completion. Does not say what the result is
- 0Inputs and preconditions. Does not say what the process needs to start
- 0Progress reporting. Says nothing while it works
- 30Running it twice. 9 mutating operations with no state check
- 55Failures and branches. 1 branches
- 60Tools and files. Uses tools (bash, web, python, node) that frontmatter does not declare
- 85Steps. 37 steps, 1 vague phrases
- 100When it triggers. States when to use and when not to
- 100Consistency. Name and required fields are in place
- 100Execution cost. Instruction body is 1327 tokens
Everything here is measured from the skill text rather than judged by a model, so the numbers are checkable. A parameter weighs more when it is a more common reason for the process to stall.
Quality signals
- +5Description has no quoted example phrases that should trigger the skill
- +3Output format is not stated: the model decides each time
- +1No license
- +2Single-language instructions
- +4Description says when NOT to use the skill
- +3Description length 367: enough signal without eating the budget
- +4Structure: 13 headings
- +3Step-by-step instructions: 37 items
- +4Has examples (3 code blocks)
- +4Reference files are cited in the instructions (3 of 3)
- +3All 1 scripts are documented
Quality base 70; lint remarks subtract, signals add up to 100. Result: 95.