BF explanation-docs
Explanation documentation patterns for understanding-oriented content - conceptual guides that explain why things work the way they do. Use when writing an explanation doc, conceptual guide, understanding/background doc, design rationale, or architecture explanation, or when asked how/why something works. Builds on the docs-style core writing principles.
As a process F 37/100 · Will not run — References files that are not bundled: ../docs-style/references/diataxis-compass.md, /concepts/related-1, /concepts/related-2
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: /concepts/related-1 - warning
missing-refreference to a missing file: /concepts/related-2 - warning
missing-refreference to a missing file: /reference/detail - warning
missing-refreference to a missing file: /concepts/cqrs-architecture - warning
missing-refreference to a missing file: /concepts/api-gateway - warning
missing-refreference to a missing file: /concepts/token-security - warning
missing-refreference to a missing file: /reference/auth-api - 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: ../tutorial-docs/SKILL.md
Process rating: all ten parameters 37/100
- 0Tools and files. 12 referenced file(s) missing: ../docs-style/references/diataxis-compass.md, /concepts/related-1, /concepts/related-2
- 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
- 20When it triggers. No condition that starts the skill
- 30Running it twice. 1 mutating operations with no state check
- 60Failures and branches. 2 branches
- 70Execution cost. Instruction body is 4605 tokens
- 100Steps. 40 steps
- 100Consistency. Name and required fields are in place
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 356: enough signal without eating the budget
- +4Structure: 24 headings
- +3Step-by-step instructions: 40 items
- +4Has examples (11 code blocks)
Quality base 70; lint remarks subtract, signals add up to 100. Result: 72.