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.

71

Quality

87%

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

78%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 well-structured, actionable process skill with a clean 10-step workflow, concrete templates and tables, and a properly signaled single reference file. Its main gaps are a few trimmable editorial asides and a missing verification gate before the destructive doc-cleanup step.

Suggestions

Add an explicit verification checkpoint in Step 4 before deleting/archiving (e.g., confirm the doc is not canonical and has no inbound links), turning it into a validate-then-act gate.

Trim pep-talk asides like "The audit is often eye-opening...", "They know.", and "Memorize it." to tighten token efficiency.

Consider moving the long Failure patterns list into a reference file to keep the core workflow leaner, since it is advisory rather than executable.

DimensionReasoningScore

Conciseness

The body is efficient and operational (standards, tables, templates) without over-explaining concepts Claude already knows, but a few editorial asides ("The audit is often eye-opening...", "They know.", "Memorize it.") could be trimmed, keeping it just below the lean 5 anchor.

4 / 5

Actionability

Concrete, usable artifacts (ADR template, output-format checklist, cadence and tooling tables, README/runbook structures) provide mostly executable guidance, but a sizable portion (failure patterns, AI notes) is advisory framing rather than executable steps, so it does not fully meet the copy-paste-ready-everywhere bar of 5.

4 / 5

Workflow Clarity

The 10-step workflow is clearly sequenced with concrete sub-steps, but the destructive archive/delete in Step 4 ("Delete or archive") lacks an explicit verification checkpoint before removal (e.g., confirm canonical/linked status first), which is a minor validation gap that prevents a 5.

4 / 5

Progressive Disclosure

The body is a well-organized overview with section headers and a clearly signaled one-level-deep reference ([references/doc-types-guide.md](references/doc-types-guide.md)) in a dedicated Reference files section, matching the clear-overview/easy-navigation 5 anchor rather than the minor-organization-gaps 4 anchor.

5 / 5

Total

17

/

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.

A strong, comprehensive description that explicitly states what the skill does and when to use it, with rich natural trigger terms and synonyms. Its only weakness is minor overlap risk with sibling content/onboarding skills in the catalog.

DimensionReasoningScore

Specificity

Lists six 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") plus "Design and run a documentation system", giving comprehensive coverage rather than the minor gaps allowed at 4.

5 / 5

Completeness

Explicitly answers both what ("Design and run a documentation system for a team or product") and when ("Use this skill when...", "Triggers on...", "Also triggers when...") with concrete trigger phrases, matching the 5 anchor rather than the 4 anchor where 'when' could be more explicit.

5 / 5

Trigger Term Quality

Comprehensive natural terms including synonyms ("documentation, docs, tech writing"), artifacts ("knowledge base, wiki, runbook, README"), and the user-voiced phrase "where do we document", plus behavioral triggers; this exceeds the 4 anchor which allows a few missing terms.

5 / 5

Distinctiveness Conflict Risk

The niche (documentation system design/audit/maintenance, not content writing) is clear and triggers are distinctive, but it shares catalog space with closely related skills (content-strategy, content-and-copy, team-onboarding-playbook) creating minor overlap risk rather than the minimal conflict risk required for 5.

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.

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.