CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

doc-freshness-review

Use when auditing repository documentation for drift, stale statements, broken references, or README mismatches, especially across published docs under `doc/` and key entry surfaces such as `README.md` (English default), `README.zh-CN.md`, `mcp/README.md`, and `mcp/README.zh-CN.md` during periodic maintenance or before preparing corrective PRs.

Quality

82%

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, instruction-only skill body: clearly phased workflow, concrete taxonomy and routing, and an appropriately split single reference. The main gaps are minor redundancy with the frontmatter description and the absence of a sample finding or example command to pattern-match against.

DimensionReasoningScore

Conciseness

The body is lean with no padding or explanations of known concepts, but the 'When to use this skill' bullets and the Routing row partially duplicate the frontmatter description and Phase 1 scope, leaving minor trimmable redundancy at anchor 4.

4 / 5

Actionability

Concrete file paths, a five-item mismatch taxonomy, explicit severity branches, and named handoff skills make the guidance mostly executable; however, no example commands or a sample drift finding are provided, keeping it below anchor 5's copy-paste-ready standard.

4 / 5

Workflow Clarity

Four clearly sequenced phases with a Phase 2 verification step, explicit severity/action branches, and a closing self-check checklist; a re-verification loop after doc edits is only implied, so it sits at anchor 4 rather than 5. The destructive/batch cap does not apply since this is a read-mostly audit with verification present.

4 / 5

Progressive Disclosure

A well-sectioned overview with a single clearly signaled, one-level-deep reference (references/review-scope.md, which exists and holds the scope detail), plus a Routing table for navigation, cleanly matching anchor 5.

5 / 5

Total

17

/

20

Passed

Description

78%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 description with an explicit trigger clause, concrete audit targets, and a distinctive niche anchored to specific repository surfaces. Its only weakness is that the capability statement is folded into the 'Use when' clause rather than separated, and a few natural trigger synonyms are absent.

DimensionReasoningScore

Specificity

Names the domain and several concrete audit objects ('drift, stale statements, broken references, or README mismatches') with specific surfaces, but rests on a single action verb (auditing) rather than multiple distinct actions, matching anchor 4.

4 / 5

Completeness

Explicit 'Use when' clause with concrete timing triggers ('periodic maintenance', 'before preparing corrective PRs') and a clear what, but the capability is embedded inside the when-clause instead of stated as a standalone what sentence, so it falls just short of anchor 5.

4 / 5

Trigger Term Quality

Good natural-keyword coverage ('auditing', 'stale statements', 'broken references', 'README mismatches', 'corrective PRs'), but misses common user phrasings such as 'docs health check' or 'outdated docs', placing it at anchor 4 rather than 5.

4 / 5

Distinctiveness Conflict Risk

Pins exact file paths ('doc/', 'README.zh-CN.md', 'mcp/README.md') to carve a clear doc-freshness niche that is distinct from general code review, API-contract review, and PR-fix skills, matching anchor 5's minimal conflict risk.

5 / 5

Total

17

/

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.

Validation — 15 / 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

TencentCloudBase/CloudBase-AI-Toolkit

Path

skills/doc-freshness-review/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.