BF howto-docs
How-To guide patterns for documentation - task-oriented guides for users with specific goals. Use when writing a how-to/howto guide, task guide, procedural guide, step-by-step guide, or how-to documentation. Builds on the docs-style core writing principles.
As a process F 47/100 · Will not run — References files that are not bundled: ../docs-style/references/diataxis-compass.md, /getting-started, /getting-started/auth
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: 2. 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: /getting-started - warning
missing-refreference to a missing file: /getting-started/auth - warning
missing-refreference to a missing file: /reference/webhook-signatures - warning
missing-refreference to a missing file: /how-to/verify-webhook-signatures - warning
missing-refreference to a missing file: /reference/webhook-events - warning
missing-refreference to a missing file: /how-to/webhook-retry-handling - warning
missing-refreference to a missing file: ../docs-style/SKILL.md - warning
missing-refreference to a missing file: ../tutorial-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 47/100
- 0Tools and files. 11 referenced file(s) missing: ../docs-style/references/diataxis-compass.md, /getting-started, /getting-started/auth
- 0Result and completion. Does not say what the result is
- 20When it triggers. No condition that starts the skill
- 30Running it twice. 8 mutating operations with no state check
- 65Failures and branches. 3 branches
- 70Inputs and preconditions. Inputs and preconditions are listed
- 85Steps. 39 steps, 1 vague phrases
- 100Consistency. Name and required fields are in place
- 100Execution cost. Instruction body is 2788 tokens
- 100Progress reporting. Reports progress
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
- +1No license
- +2Single-language instructions
- +3Description length 257: enough signal without eating the budget
- +4Structure: 22 headings
- +3Step-by-step instructions: 39 items
- +4Has examples (14 code blocks)
Quality base 70; lint remarks subtract, signals add up to 100. Result: 72.