CtrlK
BlogDocsLog inGet started
Tessl Logo

document-code

AI DevKit · Document a code entry point with structured analysis, dependency mapping, and saved knowledge docs. Use when users ask to document, understand, or map code for a module, file, folder, function, or API.

66

Quality

83%

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

75%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.

The body is an efficient, actionable, well-sequenced instruction skill: concrete commands and paths, a hard validation gate, and disciplined anti-rationalization guidance. It consistently stops just short of anchor 5 — no sample output document, no error-recovery loop, and detail (the HTML artifact spec) inlined rather than split into a reference file.

Suggestions

Add a fix-and-recheck loop to the Validation section (e.g., 'If the HTML artifact fails to render mermaid or drifts from the markdown, regenerate from the markdown and re-check') to earn the feedback-loop element of workflow clarity.

Include a short example snippet of a generated knowledge doc (one filled-in Output Template section plus a small mermaid dependency graph) to make the expected output shape concrete.

Consider moving the ~20-line HTML Artifact spec into a references/ file (e.g., references/html-artifact.md) and linking it from step 6, keeping SKILL.md as a tighter overview.

DimensionReasoningScore

Conciseness

The body is lean and assumes Claude's competence — no basic-concept explanations, just directives like "Build dependency view up to depth 3, track visited nodes to avoid loops". A few phrases could still be trimmed (e.g., "Complements the markdown — does not replace it", "this is the source of truth"), keeping it just below the every-token-earns-its-place anchor at 5.

4 / 5

Actionability

Gives executable specifics: `npx ai-devkit@latest memory search --query "<entry point name or purpose>"`, the exact output path `docs/ai/implementation/knowledge-{name}.md`, and a concrete normalization example (`calculateTotalPrice` → `calculate-total-price`). Minor gaps remain — no sample knowledge doc or mermaid snippet showing the expected output shape — so it is not fully copy-paste-ready at anchor 5.

4 / 5

Workflow Clarity

Six clearly sequenced steps with a hard gate ("Do not create documentation until the entry point is validated and analysis is complete"), entry-point verification with ambiguity handling, and a Validation section checking output coverage and HTML/mermaid rendering. However, there is no fix-and-recheck feedback loop for validation failures, so it sits at anchor 4 rather than the explicit feedback-loop anchor at 5.

4 / 5

Progressive Disclosure

A single well-sectioned SKILL.md with clear headers (Workflow, HTML Artifact, Red Flags, Validation, Output Template) and no nested or buried references — no bundle files exist. At ~86 lines with the ~20-line HTML Artifact spec inlined, content that could arguably live in a reference file is inline, matching anchor 4's minor organization gaps rather than the cleanly-split anchor 5.

4 / 5

Total

16

/

20

Passed

Description

83%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 what and an explicit Use-when clause containing concrete trigger phrases and a distinctive tool-scoped niche. Its only weaknesses are mild abstraction ("structured analysis") and a few missing natural synonyms.

DimensionReasoningScore

Specificity

Lists several concrete actions — "Document a code entry point", "dependency mapping", "saved knowledge docs" — with only minor abstraction. "Structured analysis" is not a fully concrete action, so it falls just short of the comprehensive anchor at 5 and clearly above the 1-2-action anchor at 3.

4 / 5

Completeness

Clearly answers both: what ("Document a code entry point with structured analysis, dependency mapping, and saved knowledge docs") and when ("Use when users ask to document, understand, or map code for a module, file, folder, function, or API") with concrete trigger phrases. This matches the anchor-5 good example structure exactly; anchor 4's looser 'when' does not fit better.

5 / 5

Trigger Term Quality

"document, understand, or map code for a module, file, folder, function, or API" gives good natural keyword coverage a user would plausibly say. Common variations like "explain this code" or "walk me through" are missing, which keeps it below the comprehensive synonym coverage of a 5 but well above the generic-keyword anchors at 2-3.

4 / 5

Distinctiveness Conflict Risk

The "AI DevKit" prefix and scoped entry-point types carve a mostly distinct niche, but "understand code" is broad enough to overlap with general code-explanation or onboarding skills. Minor overlap risk matches anchor 4; the minimal-conflict clarity of anchor 5 is not fully met.

4 / 5

Total

17

/

20

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.

Validation — 16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository
codeaholicguy/ai-devkit
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.