CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

doc-traceability-validator

Validate documentation traceability between code annotations (@implements), feature registry, business rules, and use cases. Detect ID collisions, undocumented features, broken cross-references, and namespace violations.

Quality

80%

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

Fix and improve this skill with Tessl

tessl review fix ./.github/skills/doc-traceability-validator/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

81%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 highly actionable, well-structured skill body with excellent validation feedback loops and a real, verifiable script bundle. Its main weakness is token efficiency: the iteration-history case study and long sample outputs pad the file without adding instructional value.

Suggestions

Cut or drastically shorten the "Real-World Example: EdgeQuake Documentation Audit (Iterations 65-75)" section — the starting/final state numbers and cross-cutting-duplicates explanation could compress to a few bullet points or move to a reference file.

Trim the illustrative script output blocks to a few representative lines (or note "run with --verbose to see the full report") since the scripts already print this at runtime.

Document or remove the bundled generate_index.py, and consider moving per-script argument tables into the scripts' own docstrings or a references file so SKILL.md stays a lean overview.

DimensionReasoningScore

Conciseness

The body is mostly efficient — executable commands, argument tables, and domain-specific tables that Claude could not infer — but it contains clearly trimmable material: the ~40-line "Real-World Example: EdgeQuake Documentation Audit (Iterations 65-75)" narrative is project history, not instruction, and the long illustrative output dumps duplicate what the scripts print at runtime. This matches the score-3 anchor (mostly efficient, some unnecessary content that could be tightened) better than score 4, where only minor instances of over-explanation would remain.

3 / 5

Actionability

Guidance is fully executable throughout: copy-paste-ready CLI invocations with real paths and flags, a complete GitHub Actions workflow, a pre-commit hook snippet, and per-script argument tables. The troubleshooting and best-practice sections give concrete numbered fixes, matching the score-5 anchor (copy-paste ready commands covering common cases) rather than score 4's "minor gaps".

5 / 5

Workflow Clarity

Sequences are explicit with validation checkpoints and feedback loops: "Document new features immediately" ends with "Run validation to confirm", every troubleshooting recipe ends with "Re-run validation", and the CI/pre-commit examples enforce thresholds. Although the skill performs batch operations (auto-generating registry entries), validation is present, so the workflow-clarity cap of 3 does not apply; this matches the score-5 anchor (explicit validation steps, error-recovery loops, checklists).

5 / 5

Progressive Disclosure

Scored against the actual bundle: all four scripts referenced in the body (validate_features.py, validate_traceability.py, generate_registry.py, check_namespace.py) plus requirements.txt exist in ./scripts/, and references are one level deep with clear section headers. It is not a 5 because the body inlines full per-script argument documentation that arguably belongs in the scripts (or a reference file), the bundled generate_index.py is never mentioned, and the "Related documents" links point at repo-relative paths outside the skill with no fallback guidance.

4 / 5

Total

17

/

20

Passed

Description

75%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 specific, distinctive, third-person description with strong action coverage, but it omits any explicit "Use when..." trigger guidance, which caps its completeness. Adding a when-to-use clause and a few natural synonyms would bring it to the top level.

Suggestions

Append an explicit trigger clause, e.g. "Use when auditing documentation coverage, resolving duplicate FEAT/BR/UC IDs, or validating registry cross-references in a codebase using @implements annotations."

Add natural synonyms and concrete artifact names users would mention, such as "duplicate feature IDs", "docs coverage", or "features.md / business_rules.md registries".

Optionally name the CI/CD gate use case ("block PRs with documentation gaps") since it is a likely user phrasing.

DimensionReasoningScore

Specificity

The description lists multiple concrete, distinct actions — "Validate documentation traceability", "Detect ID collisions", "undocumented features, broken cross-references, and namespace violations" — giving comprehensive coverage of the skill's capabilities. It matches the top anchor (multiple specific concrete actions) and exceeds the score-4 anchor, which allows minor coverage gaps; nothing here is vague or generic.

5 / 5

Completeness

The "what" is clear and concrete, but there is no "Use when..." clause or equivalent explicit trigger guidance — the "when" is only weakly implied by the domain terms. Per the judging guidelines, a missing explicit trigger clause caps completeness at 3; it is not a 4 because the when-condition is entirely absent rather than just imprecise.

3 / 5

Trigger Term Quality

Good natural keyword coverage within the domain: "documentation traceability", "ID collisions", "broken cross-references", "feature registry" are phrases a user needing this skill would plausibly say. It falls short of the score-5 anchor (comprehensive synonyms/extensions, e.g. "duplicate FEAT IDs", "doc coverage gaps", file names like "features.md") but is clearly above the score-3 anchor, which expects missing common variations.

4 / 5

Distinctiveness Conflict Risk

The description occupies a clear niche anchored by distinctive triggers — "@implements" annotations, FEAT/BR/UC registries, namespace allocation — that no generic documentation or linting skill would share. Minimal conflict risk; matches the score-5 anchor and is clearly distinct from the score-4 anchor's "minor overlap risk with closely related skills".

5 / 5

Total

17

/

20

Passed

Validation

81%

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation — 13 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

metadata_version

'metadata.version' is missing

Warning

metadata_field

'metadata' should map string keys to string values

Warning

relative_links

Relative link issues: 5 suspicious

Warning

Total

13

/

16

Passed

Repository

raphaelmansuy/edgequake

Path

.github/skills/doc-traceability-validator/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.