CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

write-docs

Write, update or review a codebase's engineering documents: READMEs, PRDs, ADRs, design docs, architecture overviews and diagrams, runbooks, API docs, PR descriptions, changelogs, migration guides, incident reviews, and agent instructions such as CLAUDE.md. Gives each reader what they need to understand, decide or act in as few words as that takes, without cutting constraints, warnings, failure behavior or uncertainty. Use it whenever you write or edit one of these documents, including a README or docs update after a code change, and when tightening wordy or AI-sounding text or checking a document against the code. Not for a small fix such as a typo, a broken link or a version number, or for code comments, commit messages or chat replies.

Quality

93%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide
SecuritybySnyk

Passed

No findings from the security scan

SKILL.md
Quality
Evals
Security

Quality

Content

90%Weight 40%Scale 1-5

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

An unusually disciplined instruction-only skill: dense, concrete, and self-consistent (it follows its own conciseness rules), with worked examples carrying real commands and explicit verification checkpoints. The workflow is clear but implicit in section ordering, and the monolithic single-file structure leaves minor progressive-disclosure headroom for the per-document-type checklists.

Suggestions

Make the end-to-end workflow explicit — e.g., a short numbered sequence (prepare → draft → verify → report) at the top — so the validation checkpoints in 'Edit before you finish' read as mandatory gates rather than prose advice.

Consider moving the 13 per-document-type checklists in 'What each document needs' into a one-level-deep reference file (e.g., references/document-types.md), keeping SKILL.md as the shared principles plus the three-question fallback.

Add an explicit fix-and-recheck loop for the verification steps (what to do when a link, command, or parse check fails) to reach the feedback-loop standard of the top workflow anchor.

DimensionReasoningScore

Conciseness

The body is maximally dense: every line states a rule, a reason, an example, or a constraint ("Cut words, never consequences"; "Put each warning right before its step"), and it never explains concepts Claude already knows (no 'what a README is' padding). It assumes competence throughout and even models its own brevity doctrine, matching 'every token earns its place' rather than the 'minor instances of over-explanation' anchor below.

5 / 5

Actionability

For an instruction-only skill the guidance is as concrete as it can be: worked contrastive examples with real commands ("Check that `kubectl config current-context` prints `staging`, then run `make restore BACKUP=<backup-id>`"), exact rewrite patterns ("the gateway checks the token", not "the token is checked"), and per-document-type checklists covering all 13 common cases named in the description. Per the rubric's code-vs-instruction note, absence of executable code is not penalized when guidance is this actionable.

5 / 5

Workflow Clarity

The workflow is present and ordered ("Before you write" → drafting sections → "Edit before you finish" → "When you reply") with explicit validation checkpoints ("Paths and links resolve, JSON and YAML examples parse, and commands exist"; when shortening, "compare the old and new versions: every condition, warning, number, prerequisite and link that's gone was wrong, obsolete or moved"). It stops short of the top anchor because the sequence is conveyed by section order rather than an explicit procedure, and feedback loops like re-checking after fixes are implied rather than spelled out.

4 / 5

Progressive Disclosure

The single file is well-organized with clear, scannable sections and no nested or buried references (none exist). However, all content lives inline in a ~100-line body — the per-document-type requirements in "What each document needs" are lookup-style material that could plausibly live in a one-level-deep reference file — so it fits 'good structure; most content appropriately placed; minor organization gaps' better than the top anchor's clean overview-plus-references split.

4 / 5

Total

18

/

20

Passed

Description

96%Weight 40%Scale 1-5

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

An exemplary description: concrete actions, comprehensive document-type coverage, an explicit 'Use when' clause with concrete trigger phrases, stated negative scope, and third-person voice throughout. Its only weakness is that the deliberately broad domain leaves minor overlap risk with narrowly specialized writing skills.

DimensionReasoningScore

Specificity

Opens with concrete actions ("Write, update or review") and comprehensively enumerates the document types covered ("READMEs, PRDs, ADRs, design docs, architecture overviews and diagrams, runbooks, API docs, PR descriptions, changelogs, migration guides, incident reviews, and agent instructions such as CLAUDE.md"), plus further actions like "tightening wordy or AI-sounding text or checking a document against the code". Coverage is comprehensive with no evident gaps, matching the top anchor rather than the 'minor gaps' level below.

5 / 5

Completeness

Both halves are explicit: 'what' is the opening verb list plus the doc-type enumeration, and 'when' is a concrete trigger clause — "Use it whenever you write or edit one of these documents, including a README or docs update after a code change, and when tightening wordy or AI-sounding text or checking a document against the code". It even adds negative scope ("Not for a small fix such as a typo, a broken link or a version number"), which goes beyond the anchor-5 example rather than falling short of it.

5 / 5

Trigger Term Quality

Natural terms users would actually say are comprehensively present: "README", "PRD", "ADR", "runbook", "changelog", "CLAUDE.md", "PR description", "migration guide", "docs update", "tightening wordy or AI-sounding text". These cover the natural phrasings and near-synonyms for the domain; the only slight omission is generic phrasing like "documentation", but coverage clearly exceeds the 'a few natural terms missing' anchor.

5 / 5

Distinctiveness Conflict Risk

The niche (codebase engineering documents) is clear and the explicit exclusions ("Not for... code comments, commit messages or chat replies") reduce conflict with adjacent writing skills. However, the very broad scope across 13 document types creates minor overlap risk with more specialized skills (e.g., a dedicated diagramming or changelog skill), fitting 'mostly distinct; minor overlap risk' better than the minimal-conflict top anchor.

4 / 5

Total

19

/

20

Passed

Validation

93%

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation — 15 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

frontmatter_unknown_keys

Unknown frontmatter key(s) found; consider removing or moving to metadata

Warning

Total

15

/

16

Passed

Repository

bezmoradi/knackpack

Path

skills/write-docs/SKILL.md

Reviewed

Table of Contents

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.