SKILLEMALL.ai
GitHub ↗ RU Sign in

BF technical-documentation

Create and review technical documentation, including READMEs, agent-facing instructions, API references, and CLI help. Use when documentation must help someone complete real work. Do not use for marketing copy, brand messaging, or long-form editorial content.

magnus919/agent-skills Agent Skills author: magnus919 MIT 7 files body ≈ 886 tokens Open the sourcegithub.com↗ analyzed 27 h ago

Create and review technical documentation, including READMEs, agent-facing instructions, API references, and CLI help.

As a process F 28/100 · Will not run — References files that are not bundled: ../documents/SKILL.md, references/information-architecture.md

IntegrationWriting and documentstype 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
91/100
safety, quality, tests
Safety 60%
100
Quality 40%
77
Run on models
none yet
Process rating
F
28/100
Will not run
References files that are not bundled: ../documents/SKILL.md, references/information-architecture.md
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
  • 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: 6. Evidence is masked. Grey chips explain why severity was lowered.

Against the Agent Skills spec

  • warning missing-ref reference to a missing file: ../documents/SKILL.md
  • warning missing-ref reference to a missing file: references/information-architecture.md

Process rating: all ten parameters 28/100

Will not run. References files that are not bundled: ../documents/SKILL.md, references/information-architecture.md
  • 0Tools and files. 2 referenced file(s) missing: ../documents/SKILL.md, references/information-architecture.md
  • 0Result and completion. Does not say what the result is
  • 0Inputs and preconditions. Does not say what the process needs to start
  • 0Failures and branches. Linear process with no failure handling
  • 0Progress reporting. Says nothing while it works
  • 25Steps. 1 steps
  • 50When it triggers. No condition that starts the skill
  • 100Consistency. Name and required fields are in place
  • 100Execution cost. Instruction body is 886 tokens
  • 100Running it twice. No mutating operations
  • medium 6 test cases, all positive: not one "should refuse" or "should ask first"
  • low No test case covers injection arriving through data

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
  • +3No numbered steps or checklist
  • +3Output format is not stated: the model decides each time
  • +4No input/output examples
  • +2Single-language instructions
  • +4Description says when NOT to use the skill
  • +3Description length 259: enough signal without eating the budget
  • +4Structure: 6 headings
  • +4Reference files are cited in the instructions (3 of 4)
  • +1License stated

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