SKILLEMALL.ai

BF technical-writing

Write clear, concise, and accurate technical documentation including API references, user guides, tutorials, changelogs, and architecture docs, tailored to the target audience. Use when the user requests technical writing or provides relevant inputs for this workflow.

seb1n/awesome-ai-agent-skills Agent Skills author: seb1n MIT 1 file body ≈ 1 721 tokens Open the sourcegithub.com analyzed 2 d ago

Write clear, concise, and accurate technical documentation including API references, user guides, tutorials, changelogs, and architecture docs, tailored to…

As a process F 51/100 · Will not run — References files that are not bundled: /docs/projects/create, /docs/webhooks

IntegrationWriting and documentsLearningMarketingtype and topics are labelled automatically from the skill text
JSON
Technical rating
B
88/100
safety, quality, tests
Safety 60%
100
Quality 40%
71
Run on models
none yet
Process rating
F
51/100
Will not run
References files that are not bundled: /docs/projects/create, /docs/webhooks
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: /docs/projects/create
  • warning missing-ref reference to a missing file: /docs/webhooks
  • note edit-residue the text marks something as outdated (lines 114): check that old rules are not kept next to new ones — the full check reads the text for contradictions

Process rating: all ten parameters 51/100

Will not run. References files that are not bundled: /docs/projects/create, /docs/webhooks
  • 0Tools and files. 2 referenced file(s) missing: /docs/projects/create, /docs/webhooks
  • 0Result and completion. Does not say what the result is
  • 0Progress reporting. Says nothing while it works
  • 30Running it twice. 9 mutating operations with no state check
  • 50Failures and branches. 0 branches, has a failure section
  • 70When it triggers. States when to use, but not when not to
  • 70Inputs and preconditions. Inputs and preconditions are listed
  • 100Steps. 22 steps
  • 100Consistency. Name and required fields are in place
  • 100Execution cost. Instruction body is 1721 tokens

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
  • +2Single-language instructions
  • +3Description length 268: enough signal without eating the budget
  • +4Structure: 8 headings
  • +3Step-by-step instructions: 22 items
  • +4Has examples (5 code blocks)
  • +1License stated

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