CtrlK
BlogDocsLog inGet started
Tessl Logo

docs-that-work

Project documentation guidelines. Use when asked to "write documentation", "create a CLAUDE.md", "write a README", "document this project", "improve documentation", or when creating/updating CLAUDE.md or README.md files.

96

1.11x
Quality

95%

Does it follow best practices?

Impact

97%

1.11x

Average score across 3 eval scenarios

SecuritybySnyk

Passed

No findings from the security scan

SKILL.md
Quality
Evals
Security

Quality

Content

100%

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

An exemplar instruction-only skill body: concise, concrete, with a clear decision workflow and clean one-level-deep reference structure that keeps the main file scannable.

DimensionReasoningScore

Conciseness

The body is lean and assumes Claude's competence — it presents methodology (the Discoverability Rule, Grey Box, three-question test) without padding or explaining basic concepts Claude already knows, and every section earns its place.

3 / 3

Actionability

Concrete, executable guidance abounds: 'target <30 lines', 'If you're past 50 lines, it's bloated. Cut ruthlessly.', explicit belongs/does-not-belong lists, and 'Never duplicate between them'; templates and examples are delegated to real reference files.

3 / 3

Workflow Clarity

The decision process is unambiguous and sequenced — apply the Discoverability Rule, then the three-question test as an explicit checkpoint, then write only what fails both — which fits the simple-skill allowance for a single, clear action.

3 / 3

Progressive Disclosure

Overview methodology lives inline while templates and the anti-pattern catalog are split into two real, one-level-deep references (anti-patterns.md, claude-md-guide.md), clearly signaled via a 'Deep Dives' table for easy navigation.

3 / 3

Total

12

/

12

Passed

Description

90%

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' trigger clause and natural keyword coverage; its only weakness is the somewhat vague one-line capability statement that leads the field.

Suggestions

Lead with concrete actions instead of 'Project documentation guidelines', e.g. 'Write and maintain CLAUDE.md and README.md files for a project' to sharpen the capability statement.

Consider adding 'update'/'refactor documentation' as an explicit action to round out the capability list beyond the trigger phrases.

DimensionReasoningScore

Specificity

The lead capability statement 'Project documentation guidelines' is vague, but concrete actions (write documentation, create a CLAUDE.md, write a README, improve documentation) are enumerated through the trigger phrases, naming the domain and several actions without being comprehensive.

2 / 3

Completeness

It explicitly answers what ('Project documentation guidelines') and when with an explicit 'Use when asked to...' clause enumerating multiple triggers, satisfying both halves.

3 / 3

Trigger Term Quality

Phrases like '"write documentation"', '"create a CLAUDE.md"', '"write a README"', '"document this project"', and 'creating/updating CLAUDE.md or README.md files' give good coverage of natural terms a user would actually say.

3 / 3

Distinctiveness Conflict Risk

The triggers carve a clear niche around CLAUDE.md and README documentation work, making it unlikely to fire for unrelated skills despite the broad opening phrase.

3 / 3

Total

11

/

12

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.

Validation16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository
provectus/awos-recruitment
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.