BF diataxis-docs-framework
Enterprise technical documentation best practices, patterns, and frameworks for developer and partner adoption. Covers content architecture (Diataxis four quadrants), 14 content types (tutorials, how-to guides, API reference, SDK docs, migration guides, changelogs, runbooks, integration guides, troubleshooting, architecture docs), pluggable writing styles (Diataxis, Google, Microsoft, Stripe, Canonical, Minimal), information architecture, docs-as-code workflows, documentation audit, anti-patterns checklist, and developer experience (DX) strategy. 27 rules, 5 references, 6 style guides. Baseline: Diataxis + Google OpenDocs + Good Docs Project. Triggers on: "write docs", "document this", "API docs", "developer docs", "migration guide", "changelog", "tutorial", "how-to guide", "reference docs", "documentation strategy", "docs audit", "information architecture", "developer experience", "partner docs", "SDK documentation", "runbook", "troubleshooting guide", "integration guide", "quickstart", "getting started", "technical writing", "docs-as-code", "DX", mentions of "Diataxis", "Good Docs Project", or "Google OpenDocs".
As a process F 52/100 · Will not run — References files that are not bundled: references/styles/[style].md
How to improve
- Shorten the description to 1024 characters.
- 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: 42. Evidence is masked. Grey chips explain why severity was lowered.
Against the Agent Skills spec
- error
description-longdescription is 1132 chars, limit 1024 - warning
missing-refreference to a missing file: references/styles/[style].md - note
frontmatter-keyunknown frontmatter key "agentic"
Process rating: all ten parameters 52/100
- 0Tools and files. 1 referenced file(s) missing: references/styles/[style].md
- 0Result and completion. Does not say what the result is
- 0Progress reporting. Says nothing while it works
- 30Running it twice. 2 mutating operations with no state check
- 40Consistency. Frontmatter name (diataxis-docs-framework) differs from the folder (developer-docs-framework)
- 70When it triggers. States when to use, but not when not to
- 70Inputs and preconditions. Inputs and preconditions are listed
- 100Steps. 33 steps
- 100Failures and branches. 1 branches, has a failure section
- 100Execution cost. Instruction body is 3964 tokens
- medium Safety rules and hard prohibitions inside a skill: they belong in the system prompt, here they protect nothing
- low 17 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
- +4Description does not say when NOT to use the skill (false activations)
- +3Description length 1131: 120–800 characters recommended
- +3Output format is not stated: the model decides each time
- +2Single-language instructions
- +5Description quotes 25 example trigger phrases
- +4Structure: 25 headings
- +3Step-by-step instructions: 33 items
- +4Has examples (3 code blocks)
- +4Reference files are cited in the instructions (8 of 32)
- +1License stated
Quality base 70; lint remarks subtract, signals add up to 100. Result: 59.