CtrlK
BlogDocsLog inGet started
Tessl Logo

documentation-strategy

Design and run a documentation system for a team or product. Use this skill when planning what to document, choosing a documentation tool, organizing existing docs, fixing stale documentation, designing a maintenance cadence, or scoping technical writing work. Triggers on documentation, docs, tech writing, knowledge base, wiki, runbook, README, internal docs, doc audit, doc maintenance, stale docs, where do we document. Also triggers when the team is repeatedly answering the same questions or when onboarding takes too long.

74

Quality

92%

Does it follow best practices?

Impact

No eval scenarios have been run

SecuritybySnyk

Passed

No known issues

SKILL.md
Quality
Evals
Security

Quality

Content

85%

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 well-structured, highly actionable strategy skill with a clear workflow and a properly signaled single reference file. Its main weakness is length and editorial commentary that could be trimmed for token efficiency.

Suggestions

Tighten or remove rhetorical commentary (e.g. 'The audit is often eye-opening', 'The team that ships features without docs has less than they think they have') to reduce tokens without losing guidance.

De-duplicate the Diátaxis category detail between the body and references/doc-types-guide.md, keeping the body to a brief summary that points to the reference.

Consider condensing the 14-item 'Failure patterns' list into the most impactful entries or moving the full list into a reference file.

DimensionReasoningScore

Conciseness

Mostly efficient with concrete lists, tables, and templates, but the body is long (~400 lines) with recurring rhetorical commentary ('The audit is often eye-opening', 'Stale docs are worse than missing docs') and some redundancy with the doc-types reference, so it could be tightened rather than scoring a lean 3.

2 / 3

Actionability

Concrete and actionable throughout — a 10-step workflow, a copy-ready ADR template, a per-tier maintenance-cadence table, a tooling comparison table, and specific patterns (e.g. README answering four questions in 'five sentences each'), satisfying the instruction-only actionable anchor.

3 / 3

Workflow Clarity

The 10-step workflow (Audit → Categorize → Gaps → Dead weight → Homes → Ownership → Cadence → Part-of-work → Discoverable → Measure) is clearly sequenced and logically progressive; the destructive/batch validation cap does not apply to this planning workflow.

3 / 3

Progressive Disclosure

Well-organized overview sections with a single, clearly signaled one-level-deep reference — '[`references/doc-types-guide.md`](references/doc-types-guide.md)' — that exists as a real bundle file, matching the clear-navigation anchor.

3 / 3

Total

11

/

12

Passed

Description

100%

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 is specific, third-person, and clearly states both capability and trigger conditions with a rich set of natural keywords. It distinguishes itself well from neighboring content/copy skills. No changes needed.

DimensionReasoningScore

Specificity

Lists multiple concrete actions — 'planning what to document, choosing a documentation tool, organizing existing docs, fixing stale documentation, designing a maintenance cadence, or scoping technical writing work' — in third person, matching the score-3 anchor.

3 / 3

Completeness

Explicitly answers both what ('Design and run a documentation system for a team or product') and when ('Use this skill when...'; 'Triggers on...'), satisfying the full what+when anchor.

3 / 3

Trigger Term Quality

Strong natural-term coverage — 'documentation, docs, tech writing, knowledge base, wiki, runbook, README, internal docs, doc audit, doc maintenance, stale docs, where do we document' — including phrasings users would actually say.

3 / 3

Distinctiveness Conflict Risk

Targets a clear niche (documentation system design/maintenance) with distinct triggers unlikely to fire for adjacent content skills, which are instead listed in the body's 'When NOT to use' section.

3 / 3

Total

12

/

12

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.

Validation15 / 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
rampstackco/claude-skills
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.