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

81%

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

The canonical home for this skill is documentation-and-adrs in addyosmani/agent-skills

SKILL.md
Quality
Evals
Security

Quality

Content

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

The body is a strong instruction-style skill: concrete templates and examples dominate, the convention-matching decision flow is well-sequenced, and it ends with a verification checklist. Its main weaknesses are mild verbosity in areas Claude already knows (README/changelog formats, a rationalizations table) and missed opportunities to move example material into reference files for progressive disclosure. No time-sensitive or version-anchored content is present.

DimensionReasoningScore

Conciseness

The body is overwhelmingly example-driven (ADR template, good/bad comment pairs, TSDoc, OpenAPI, verification checklist) rather than explaining concepts Claude already knows. Not 5 because the README structure and changelog templates restate formats Claude already knows, and the "Common Rationalizations" table is motivational padding that could be trimmed.

4 / 5

Actionability

Fully copy-paste-ready guidance throughout: a complete worked ADR template with alternatives and consequences, executable TypeScript comment examples with explicit BAD/GOOD contrasts, a full TSDoc example, an OpenAPI snippet, and a terminal verification checklist. Specific examples cover the common documentation cases.

5 / 5

Workflow Clarity

The primary workflow is clearly sequenced: inspect for existing convention first (location, numbering, headings), match it, surface conflicts explicitly, and only then apply the default template — plus a closing Verification checklist as checkpoints. Not 5 because there is no explicit error-recovery/feedback loop; not 3 because checkpoints are present and explicit rather than implicit.

4 / 5

Progressive Disclosure

Well-organized single file with clear section headers and no nested or buried references (there are no bundle files at all). Not 5 because at ~280 lines the README, changelog, and API-documentation example blocks are candidates for reference files to slim the main file, and the under-50-line simple-skill exception does not apply. Not 3 because nothing is buried and structure is consistently good.

4 / 5

Total

17

/

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.

The description has an explicit, multi-trigger when-clause in proper third-person voice, but its what-statement is generic ("Records decisions and documentation") and omits several natural trigger terms the skill body actually covers (README, changelog, code comments, rules files). It is solid but below the exemplar level where concrete capabilities are enumerated. No voice violations were found.

Suggestions

Replace the generic what-statement with concrete capabilities, e.g. "Write architecture decision records (ADRs), add rationale-focused code comments, generate README and changelog entries, and document public APIs."

Add trigger terms for tasks the body covers but the description omits: writing/updating a README, maintaining a changelog, adding code comments or docblocks, and CLAUDE.md/rules-file conventions.

Narrow the broad "shipping features" trigger to feature changes that alter user-facing behavior or introduce a decision worth recording, to reduce overlap with changelog/commit-message skills.

DimensionReasoningScore

Specificity

"Records decisions and documentation" names the domain with a single generic action verb; the concrete specifics (ADR, design choice, public APIs) appear only in the when-clause, so the what-side lists 1-2 actions without comprehensive coverage. Not 4 because the description's capability statement itself offers no specific concrete actions like the anchor-4 example.

3 / 5

Completeness

Both what and when are present, and the "Use when..." clause is explicit with multiple concrete triggers (5-level when). Not 5 because the what-side — "Records decisions and documentation" — is a single vague action, far short of the anchor-5 example's list of concrete capabilities. Not 3 because both halves are clearly and explicitly present.

4 / 5

Trigger Term Quality

Natural phrases users would say are present — "document an architecture decision (ADR)", "the reasoning behind a design choice", "changing public APIs", "shipping features". Not 5 because common natural terms the skill actually covers — README, changelog, code comments, CLAUDE.md/rules files — are missing from the description, so those user requests would not trigger it.

4 / 5

Distinctiveness Conflict Risk

The ADR/design-rationale niche has distinct triggers, but "shipping features" and "record context that future engineers... need to understand the codebase" are broad and could overlap with changelog, commit-message, or README-type skills. Not 5 due to this residual overlap; not 3 because the primary triggers are clearly specific to decision documentation.

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

faisalbasra/match-storyteller

Path

.agents/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.