SKILLEMALL.ai
GitHub ↗ RU Sign in

BD writing-reference-docs

How to write a function/hook/action reference section, and how to write or rework a whole app's multi-page doc set (Overview/Features/Talk to the Agent/Cross-App Use/Developer Guide): plain-language signature, real arguments, escalating examples grounded in a real app, verified agent behavior, trimmed prose with no em dashes or semicolons. Use when writing or editing a packages/core/docs/content reference page, or reworking a template-<app>*.mdx doc set.

BuilderIO/agent-native Agent Skills author: BuilderIO 1 file body ≈ 3 369 tokens Open the sourcegithub.com↗ analyzed 3 d ago

How to write a function/hook/action reference section, and how to write or rework a whole app's multi-page doc set (Overview/Features/Talk to the…

As a process D 46/100 · Unfinished process — References files that are not bundled: ..., scripts/i18n-no-translate-terms.txt

ProcedureAI and agentstype and topics are labelled automatically from the skill text
Runs in: 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) OpenClaw Goose OpenCode
JSON
Technical rating
B
90/100
safety, quality, tests
Safety 60%
100
Quality 40%
74
Run on models
none yet
Process rating
D
46/100
Unfinished process
References files that are not bundled: ..., scripts/i18n-no-translate-terms.txt
Tools and files w 18
0
Result and completion w 14
0
Progress reporting w 2
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: 1. Evidence is masked. Grey chips explain why severity was lowered.

Against the Agent Skills spec

  • warning missing-ref reference to a missing file: ...
  • warning missing-ref reference to a missing file: scripts/i18n-no-translate-terms.txt
  • note frontmatter-key unknown frontmatter key "scope"

Process rating: all ten parameters 46/100

Will not run. References files that are not bundled: ..., scripts/i18n-no-translate-terms.txt
  • 0Tools and files. 2 referenced file(s) missing: ..., scripts/i18n-no-translate-terms.txt
  • 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. 27 steps
  • 100Consistency. Name and required fields are in place
  • 100Execution cost. Instruction body is 3369 tokens
  • low 10 top-level sections: this looks like several domains in one skill
  • low The response is described with custom markup (4 tags): a typed call is more reliable

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 458: enough signal without eating the budget
  • +4Structure: 15 headings
  • +3Step-by-step instructions: 27 items
  • +4Has examples (1 code blocks)

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