AF tutorial-docs
Tutorial patterns for documentation - learning-oriented guides that teach through guided doing. Use when writing a tutorial, learning guide, getting-started or onboarding guide, beginner/introductory guide, or any learn-by-doing hands-on guide. Builds on the docs-style core writing principles.
As a process F 46/100 · Will not run — References files that are not bundled: ../docs-style/references/diataxis-compass.md, /images/tutorial-dashboard.png, ../docs-style/SKILL.md
How to improve
- The text references files that are not there: add them or drop the references.
- 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: 3. Evidence is masked. Grey chips explain why severity was lowered.
Against the Agent Skills spec
- warning
missing-refreference to a missing file: ../docs-style/references/diataxis-compass.md - warning
missing-refreference to a missing file: /images/tutorial-dashboard.png - warning
missing-refreference to a missing file: ../docs-style/SKILL.md - warning
missing-refreference to a missing file: ../howto-docs/SKILL.md - warning
missing-refreference to a missing file: ../reference-docs/SKILL.md - warning
missing-refreference to a missing file: ../explanation-docs/SKILL.md
Process rating: all ten parameters 46/100
- 0Tools and files. 6 referenced file(s) missing: ../docs-style/references/diataxis-compass.md, /images/tutorial-dashboard.png, ../docs-style/SKILL.md
- 0Result and completion. Does not say what the result is
- 0Progress reporting. Says nothing while it works
- 20When it triggers. No condition that starts the skill
- 30Running it twice. 8 mutating operations with no state check
- 55Failures and branches. 1 branches
- 70Inputs and preconditions. Inputs and preconditions are listed
- 100Steps. 34 steps
- 100Consistency. Name and required fields are in place
- 100Execution cost. Instruction body is 2841 tokens
- low 10 top-level sections: this looks like several domains in one skill
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
- +4Description does not say when NOT to use the skill (false activations)
- +3Output format is not stated: the model decides each time
- -2localhost URLs: will not work for another user
- +1No license
- +2Single-language instructions
- +3Description length 294: enough signal without eating the budget
- +4Structure: 27 headings
- +3Step-by-step instructions: 34 items
- +4Has examples (18 code blocks)
- +4Reference files are cited in the instructions (1 of 1)
Quality base 70; lint remarks subtract, signals add up to 100. Result: 74.