SKILLEMALL.ai
RU Sign in

BF reference-docs

Reference documentation patterns for API and symbol documentation. Use when writing reference docs, API docs, parameter tables, or technical specifications. Triggers on reference docs, API reference, function reference, parameters table, symbol documentation.

ClawHub Agent Skills author: Kevin Anderson v1.0.2 MIT-0 2 files body ≈ 2 741 tokens Open the sourceclawhub.ai↗ analyzed 2 d ago

As a process F 52/100 · Will not run — References files that are not bundled: ../docs-style/references/diataxis-compass.md, /reference/related-symbol, /reference/another-symbol

IntegrationWriting and documentstype and topics are labelled automatically from the skill text
Runs in: OpenClaw Claude / Claude Code ChatGPT / Codex Gemini CLI Cursor GitHub Copilot / VS Code Qwen Code Kimi Code CLI Z.ai (GLM) DeepSeek (Deep Code) Mistral Vibe LangChain (deepagents) Goose OpenCode
JSON
Technical rating
B
87/100
safety, quality, tests
Safety 60%
100
Quality 40%
67
Run on models
none yet
Process rating
F
52/100
Will not run
References files that are not bundled: ../docs-style/references/diataxis-compass.md, /reference/related-symbol, /reference/another-symbol
Tools and files w 18
0
Result and completion w 14
0
Inputs and preconditions w 11
0
the three weakest of ten parameters · all ten

How to improve

  1. The text references files that are not there: add them or drop the references.
For the model run — optional
  • 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-ref reference to a missing file: ../docs-style/references/diataxis-compass.md
  • warning missing-ref reference to a missing file: /reference/related-symbol
  • warning missing-ref reference to a missing file: /reference/another-symbol
  • warning missing-ref reference to a missing file: /reference/create-user
  • warning missing-ref reference to a missing file: /reference/update-user
  • warning missing-ref reference to a missing file: /reference/delete-user
  • warning missing-ref reference to a missing file: /guides/authentication
  • warning missing-ref reference to a missing file: ../docs-style/SKILL.md
  • warning missing-ref reference to a missing file: ../tutorial-docs/SKILL.md
  • warning missing-ref reference to a missing file: ../howto-docs/SKILL.md
  • warning missing-ref reference to a missing file: ../explanation-docs/SKILL.md

Process rating: all ten parameters 52/100

Will not run. References files that are not bundled: ../docs-style/references/diataxis-compass.md, /reference/related-symbol, /reference/another-symbol
  • 0Tools and files. 11 referenced file(s) missing: ../docs-style/references/diataxis-compass.md, /reference/related-symbol, /reference/another-symbol
  • 0Result and completion. Does not say what the result is
  • 0Inputs and preconditions. Does not say what the process needs to start
  • 50Failures and branches. 0 branches, has a failure section
  • 100Steps. 34 steps
  • 100When it triggers. States when to use and when not to
  • 100Consistency. Name and required fields are in place
  • 100Execution cost. Instruction body is 2741 tokens
  • 100Running it twice. No mutating operations
  • 100Progress reporting. Reports progress
  • low 13 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
  • -5TODO / placeholder text left in the skill
  • +1No license
  • +2Single-language instructions
  • +3Description length 259: enough signal without eating the budget
  • +4Structure: 30 headings
  • +3Step-by-step instructions: 34 items
  • +4Has examples (22 code blocks)

Quality base 70; lint remarks subtract, signals add up to 100. Result: 67.

External checks

ClawHub: clean
This skill is a documentation-writing guide with no executable code, persistence, or sensitive access.
LLM: benign (high) · VirusTotal: · 25 Jun 2026