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.

68

Quality

85%

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

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

Highly actionable content with complete templates, clear sequencing, and genuine validation checkpoints (prose-review feedback loop plus a final verification checklist). The main cost is token efficiency: several sections teach documentation practices Claude already knows, and the 290-line body could offload secondary templates to reference files.

Suggestions

Trim or remove the 'Common Rationalizations' table and the 'When NOT to Comment' code examples — Claude already knows these conventions, and the 'When NOT to use' bullet list already covers the same ground in a fraction of the tokens.

Replace the full README and Changelog templates with a one-line summary of required sections (or move them to a references/templates.md file), since Claude can generate these standard formats without a full worked example.

Consider moving the API Documentation examples (TSDoc and OpenAPI blocks, ~40 lines) into a one-level-deep reference file, keeping only a pointer and one short example in SKILL.md.

DimensionReasoningScore

Conciseness

The ADR template, convention-matching procedure, and prose-review steps earn their tokens, but the "Common Rationalizations" table, the "When NOT to Comment" examples, and the Changelog section restate practices Claude already knows. Mostly efficient with some sections that could be trimmed, which is more than the 'minor instances' required for a 4.

3 / 5

Actionability

Fully actionable: a complete copy-paste ADR template with a worked PostgreSQL example, an explicit convention-matching procedure with fallback logic, executable TypeScript and OpenAPI examples, README/changelog templates, and a concrete three-step prose review. Specific examples cover the common documentation cases.

5 / 5

Workflow Clarity

Multi-step processes are clearly sequenced with validation: the ADR flow (inspect convention → match location/numbering/headings → surface conflicts → apply default), the prose review's mark/check/compare loop with error recovery ("Restore any lost qualifier or caveat... explain any unresolved factual question"), and a closing Verification checklist of explicit checkpoints.

5 / 5

Progressive Disclosure

A single ~290-line file with no bundle files, but well-organized into clearly signaled sections (ADRs, Inline Documentation, API Documentation, README, Changelog, Prose Review, Verification) and no nested references. Not a 5 because it exceeds the simple-skill case and secondary material (API doc examples, README/changelog templates) could be split into reference files; not a 3 because no section is an oversized inline reference block.

4 / 5

Total

17

/

20

Passed

Description

83%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 strong description with an explicit 'Use when...' clause, concrete ADR-specific triggers, and correct third-person voice. Its main weaknesses are a generic opening capability statement and missing natural synonyms for the broader documentation tasks (README, changelog, API docs) the skill actually covers.

DimensionReasoningScore

Specificity

The description names several specific actions — "document an architecture decision (ADR)", "the reasoning behind a design choice", "record context that future engineers and agents will need" — though the opening "Records decisions and documentation" is generic and the actions are carried by 'when' clauses rather than a clean capability list.

4 / 5

Completeness

Both what and when are explicitly answered with concrete trigger phrases: what — "Records decisions and documentation" including "document an architecture decision (ADR) or the reasoning behind a design choice"; when — "Use when you need to document... when changing public APIs, shipping features, or when you need to record context".

5 / 5

Trigger Term Quality

Good natural-term coverage: "architecture decision (ADR)", "design choice", "public APIs", "shipping features" are phrases users would actually say. A few natural terms are missing — no synonyms like "decision record", "rationale", "README", "changelog", or "comments" that the skill body actually covers.

4 / 5

Distinctiveness Conflict Risk

The ADR/decision-record niche is mostly distinct with specific triggers, but "Records decisions and documentation" and "shipping features" are broad enough to overlap with general writing or release-focused skills.

4 / 5

Total

17

/

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.