CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

documentation-and-adrs

Records decisions and documentation. Use when you need to document an architecture decision (ADR) or the reasoning behind a design choice, when changing public APIs, shipping features, or when you need to record context that future engineers and agents will need to understand the codebase.

Quality

78%

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

Fix and improve this skill with Tessl

tessl review fix ./skills/documentation-and-adrs/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

75%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.

A strong, instruction-only skill whose value is almost entirely concrete templates and worked examples, with explicit convention-matching guidance and a verification checklist. Its main weaknesses are moderate motivational padding (Overview rationale, Common Rationalizations table) and the lack of a single unifying workflow ordering when to produce each artifact.

Suggestions

Cut the Overview rationale paragraph and the 'Common Rationalizations' table — Claude already knows why documentation matters, and the freed tokens could shorten the ADR template to its structural skeleton.

Add a short decision sequence at the top (significant decision → ADR; public API → TSDoc/OpenAPI; shipped feature → changelog entry; project-level info → README/rules files) so the reader knows which artifact to reach for without scanning all sections.

Consider moving the ADR template and README/changelog skeletons into a references/ file so SKILL.md stays a lean overview, keeping the inline inline-comment and gotcha examples that are needed at decision time.

DimensionReasoningScore

Conciseness

The bulk of the body is concrete, copy-paste-ready template material (ADR template, comment good/bad examples, TSDoc/OpenAPI snippets, README and changelog skeletons), but motivational padding Claude doesn't need remains — the Overview rationale ('Code shows what was built; documentation explains why...') and the entire 'Common Rationalizations' table arguing against excuses like "The code is self-documenting". Trimming those sections and tightening the ADR template would bring it to anchor 4; it is above anchor 2 because no section extensively explains concepts Claude already knows.

3 / 5

Actionability

Every section delivers executable artifacts: a complete fill-in ADR template with Status/Context/Decision/Alternatives/Consequences, GOOD-vs-BAD comment examples, a full TSDoc block with @param/@throws/@example, an OpenAPI YAML snippet, README and changelog skeletons, and a 3-step prose review procedure. As an instruction-only skill this matches the top anchor: specific examples cover the common cases and are copy-paste ready; it is not score 4 territory because there are no pseudocode or gap-filled examples.

5 / 5

Workflow Clarity

Sub-processes are well sequenced with validation: the ADR flow explicitly orders 'inspect for existing convention first → only then apply the default template', the lifecycle defines supersede-not-delete, Prose Review is a numbered 3-step loop with 'Compare the edited document with the original and its sources. Restore any lost qualifier', and a closing Verification checklist provides explicit checkpoints. It falls short of anchor 5 because the overall skill has no single entry-point sequence tying the sections together (when to write which artifact vs. review prose vs. verify), and the README/changelog sections give templates without any verify step of their own; it clearly exceeds anchor 3 where checkpoints would be merely implicit.

4 / 5

Progressive Disclosure

A self-contained single-file skill (no references/, scripts/, or assets/ exist) with well-organized, clearly headed sections and zero nested references. It sits at anchor 4 rather than 5 because at ~295 lines it exceeds the under-50-line simple-skill exception, and bulky template content (the 40-line ADR template, README structure, changelog example) could arguably live in separate reference files; it is above anchor 3 since nothing is buried and every section is clearly signaled and appropriately scoped for an overview-plus-templates document.

4 / 5

Total

16

/

20

Passed

Description

70%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.

A well-formed description in third person with an explicit, multi-trigger 'Use when' clause and natural ADR/design-choice vocabulary. Its main limitation is an underspecified 'what' — 'Records decisions and documentation' hides the skill's actual breadth (ADRs, changelogs, API docs, READMEs, inline gotchas).

Suggestions

Enumerate the concrete outputs in the description, e.g. 'Writes ADRs, inline code comments, API documentation (TSDoc/OpenAPI), READMEs, and changelogs.'

Add missing natural trigger terms such as 'decision record', 'changelog', or 'README' so users phrasing a request those ways surface the skill.

DimensionReasoningScore

Specificity

The 'what' is 'Records decisions and documentation' — a generic action verb plus domain — with only one concrete artifact named ('document an architecture decision (ADR)'). It never mentions the READMEs, changelogs, API docs, or inline gotcha documentation the skill actually covers, so it matches anchor 3 (domain plus 1-2 concrete actions, not comprehensive) rather than anchor 4's 'several specific actions'; it is well above anchor 2 because ADR recording is a genuinely concrete, named capability.

3 / 5

Completeness

Both parts are explicit: 'what' ('Records decisions and documentation') and a full 'Use when...' clause with multiple concrete triggers (documenting an ADR, recording design reasoning, changing public APIs, shipping features, recording context for future engineers/agents). It stops short of anchor 5 because the 'what' side is thin — it does not enumerate the concrete outputs (ADRs, changelogs, API documentation, READMEs) the way the anchor-5 example lists its actions — but it is comfortably above anchor 4's 'when could be more explicit', since the when-clause is specific and multi-trigger.

4 / 5

Trigger Term Quality

Natural user phrasing is well represented: 'document an architecture decision (ADR)', 'the reasoning behind a design choice', 'changing public APIs', 'shipping features'. A few natural terms users would say are missing — 'decision record', 'changelog', 'README', 'write docs' — so it fits anchor 4 ('good keyword coverage; a few natural terms missing') rather than anchor 5's comprehensive synonym coverage, while clearly exceeding anchor 3's partial coverage.

4 / 5

Distinctiveness Conflict Risk

The ADR/design-decision niche is distinct with trigger phrases unlikely to fire for writing or code-review skills, matching anchor 4 ('mostly distinct; minor overlap risk'). The generic tail 'record context that future engineers and agents will need' and the word 'documentation' create minor overlap with general documentation-writing skills, keeping it below anchor 5's clear niche with minimal conflict risk.

4 / 5

Total

15

/

20

Passed

Validation

100%

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

Validation — 16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository

addyosmani/agent-skills

Path

skills/documentation-and-adrs/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.