CtrlK
BlogDocsLog inGet started
Tessl Logo

docs-guard

Review generated or changed documentation before it ships — READMEs, API references, docstrings, PHPDoc/JSDoc, changelogs, tutorials, and doc sites. Best used reactively after an agent writes or edits docs, after code changes documented behavior, or before publishing docs. Use when the user says 'review the docs', 'is this documentation accurate', 'update the docs', 'write a README', 'document this API', 'add a docstring', or 'add a changelog entry'. Core job: verify every referenced function, flag, endpoint, config key, and code sample against the source; catch docs-vs-code drift; strip filler and unverifiable claims. DO NOT USE for production code review (use clean-code-guard), test review (use test-guard), marketing copy or blog posts, prose style editing of non-technical writing, or documentation site theming.

80

Quality

100%

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

100%Weight 40%Scale 1-3

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 tight, purposeful guard spec: lean prose, concrete and actionable rules, a sequenced workflow with a self-check gate, and clean one-level-deep progressive disclosure to verified reference files. No filler or concept-explanation that Claude already knows.

DimensionReasoningScore

Conciseness

The body is lean and assumes Claude's competence — it never explains what READMEs, docstrings, or symbols are. The brief published-research stat directly motivates the guard's premise rather than padding, and each rule earns its place, matching the 'lean and efficient; every token earns its place' anchor rather than including unnecessary explanation (2).

3 / 3

Actionability

As an instruction-only skill its guidance is concrete and executable ('verify... by reading it, not recalling it', 'Grep the docs for the old symbol before finishing', 'Read the implementation before describing it') with a copy-paste reporting template and a mechanical verification procedure referenced, matching the actionable anchor; per scoring notes absence of code is not penalized.

3 / 3

Workflow Clarity

The workflow is clearly sequenced (adapt to project -> apply rules grouped by severity -> self-check -> report) with an explicit validation gate ('If any answer is wrong, fix it before showing the user'), matching the 'clear sequence with explicit validation steps' anchor rather than listing steps with implicit checkpoints (2).

3 / 3

Progressive Disclosure

SKILL.md is a clear overview with well-signaled, one-level-deep references to five real bundle files (all verified present: verification, code-samples, docstrings, review-checklist, sources), content is appropriately split out of the main body, and a dedicated References section describes each file's purpose, matching the 'clear overview with well-signaled one-level-deep references' anchor.

3 / 3

Total

12

/

12

Passed

Description

100%Weight 40%Scale 1-3

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, trigger-rich, and complete, with explicit 'when to use' guidance and strong boundary-setting against clean-code-guard and test-guard. It uses consistent third-person voice and avoids vague fluff.

DimensionReasoningScore

Specificity

Lists multiple concrete actions ('verify every referenced function, flag, endpoint, config key, and code sample against the source', 'catch docs-vs-code drift', 'strip filler and unverifiable claims') and enumerates specific doc surfaces, matching the 'lists multiple specific concrete actions' anchor rather than naming only some actions (2).

3 / 3

Completeness

Explicitly answers both what (review/verify docs, catch drift, strip filler) and when, with an explicit 'Use when the user says...' trigger clause plus reactive timing guidance, matching the anchor that clearly answers both with explicit triggers rather than leaving when only implied (2).

3 / 3

Trigger Term Quality

Provides strong natural-language coverage users would actually say ('review the docs', 'is this documentation accurate', 'write a README', 'document this API', 'add a docstring', 'add a changelog entry'), matching the 'good coverage of natural terms' anchor rather than missing common variations (2).

3 / 3

Distinctiveness Conflict Risk

Carves a clear niche (documentation vs code) and explicitly disambiguates via 'DO NOT USE for production code review (use clean-code-guard), test review (use test-guard)...', matching the 'clear niche with distinct triggers; unlikely to conflict' anchor rather than overlapping with similar skills (2).

3 / 3

Total

12

/

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
amElnagdy/guard-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.