CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

document-this

Generate multi-audience documentation from any codebase — workflows for non-technical readers, architecture for developers, and AI orientation for agents. Deterministic JS scripts handle structural extraction; the agent writes the prose. Project-agnostic and self-orienting. Use when the user asks to "document this project", runs `/document-this`, runs `/document-this <file-path>`, runs `/document-this --focus "<Feature Name>"` for a deep-dive on one subsystem in a named subfolder, or wants fresh documentation reflecting the current codebase state.

Quality

78%

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 ./skills/document-this/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

56%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 a well-sequenced, largely executable instruction set for three documentation modes, with explicit ordering, stop conditions, and overwrite guardrails. Its two real defects are redundancy (slug and no-README rules repeated 3–4 times) and a bundle mismatch: every phase depends on 7 template files referenced under templates/ that are absent from the bundle, breaking both actionability and navigation.

Suggestions

Ship the templates/ directory referenced by the body (README.template.md, workflows.template.md, workflow-entry.template.md, architecture.template.md, ai-orientation.template.md, focus-workflows.template.md, focus-architecture.template.md) — or remove the Templates section and inline the essential scaffold shapes, since every generation phase currently instructs the agent to use files that don't exist.

Consolidate the slug-derivation rules (currently stated in Invocation, Output, Slug derivation, and Quality Rules) and the 'no README/ai-orientation in the subfolder' rule (stated three times) into a single authoritative section, cutting ~25 lines without losing any instruction.

Add an explicit validation step at the end of each generation phase — e.g., verify the generated Mermaid files render and spot-check that documented workflows trace to real test files — to close the workflow-clarity gap between checkpoint presence and output verification.

DimensionReasoningScore

Conciseness

The body is dense and imperative with no explanations of concepts Claude already knows, but it repeats the same instructions several times: slug-derivation rules appear four times (Invocation, Output, 'Slug derivation', Quality Rules), the 'no README/ai-orientation in the subfolder' rule three times (Output, Phase F preamble, Quality Rules), and the '../' path rule twice. This matches the score-3 anchor ('mostly efficient... could be tightened'); not 4 because the redundancy goes beyond minor instances, not 2 because the bulk is genuinely lean.

3 / 5

Actionability

Commands are concrete and executable ('node skills/document-this/scripts/fingerprint.mjs' etc. — all 7 scripts verified present) with exact output trees and numbered steps, but nearly every writing phase mandates scaffolds that don't exist in the bundle ('Write each workflow using templates/workflow-entry.template.md', 'Use templates/focus-architecture.template.md') — all 7 referenced template files are missing. That is a missing key detail beyond the 'minor gaps' of score 4, but the rest of the guidance is far more concrete than score 2's high-level hints.

3 / 5

Workflow Clarity

Phases are explicitly ordered ('Execute in this order. Each step's output informs the next.'; Phases 1–5, F1–F4) with stop/verify checkpoints ('If the scoping set is empty or trivially small, stop and tell the user', 'Confirm the file is in scope... If not, tell the user and stop', 'When scripts disagree with disk, trust disk') and overwrite guardrails ('pick a different form rather than overwriting', 'Do not touch the top-level generated-docs/*.md files', 'Use git diff generated-docs/ to review') — matching score 4. Not 5: no explicit output validation (e.g., verifying the generated Mermaid renders) or error-recovery loops; not 3: sequence is coherent with most checkpoints present.

4 / 5

Progressive Disclosure

Sectioning is good (Overview, Invocation, Output, Scripts table, Templates, per-mode processes, Quality Rules) and deterministic detail is properly offloaded to scripts — but scored against the actual bundle, all 7 files referenced under 'Templates' are dangling: the templates/ directory does not exist, so half the skill's referenced bundle files don't resolve. That structural defect goes beyond the 'minor organization gaps' of score 4, while the overall structure is still clearly navigable, keeping it above score 2's inlined-content anchor.

3 / 5

Total

13

/

20

Passed

Description

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

The description is strong: it answers what and when explicitly, in third person, with concrete trigger phrases covering all invocation modes and no fluff beyond a brief two-word framing ('Project-agnostic and self-orienting'). The only weakness is moderate natural-keyword coverage — triggers lean on the slash-command name rather than the range of plain-language phrasings a user might naturally say.

DimensionReasoningScore

Specificity

Multiple concrete actions are listed: 'Generate multi-audience documentation from any codebase — workflows for non-technical readers, architecture for developers, and AI orientation for agents', plus 'Deterministic JS scripts handle structural extraction' and the three invocation variants (targeted update, feature deep-dive). Coverage is comprehensive for what the skill does, matching the score-5 anchor of multiple specific concrete actions; score 4 would require minor coverage gaps that aren't present.

5 / 5

Completeness

Both 'what' and 'when' are explicitly answered with concrete trigger phrases: the what ('Generate multi-audience documentation... workflows for non-technical readers, architecture for developers, and AI orientation for agents') and an explicit 'Use when the user asks to "document this project", runs /document-this...' clause — exactly the score-5 anchor. Not 4: the 'when' could not be more explicit; it enumerates all invocation forms.

5 / 5

Trigger Term Quality

Natural triggers are explicit: 'document this project', '/document-this', '/document-this <file-path>', '/document-this --focus "<Feature Name>"', and 'fresh documentation reflecting the current codebase state' — good keyword coverage as in the score-4 anchor. Not 5: common natural phrasings users would say are missing (e.g., 'write the docs', 'update the documentation', 'document this codebase/repo' as user utterances, and synonyms beyond the command name).

4 / 5

Distinctiveness Conflict Risk

Clear niche (codebase documentation generation for three audiences) with distinct, unambiguous triggers (the named /document-this command and 'document this project' phrasing), so it's unlikely to fire for the wrong skill — the score-5 anchor. Not 4: there is no meaningful overlap with closely related skills; the command-name trigger makes collisions minimal.

5 / 5

Total

19

/

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

relative_links

Relative link issues: 1 missing, 1 suspicious

Warning

Total

15

/

16

Passed

Repository

RoleModel/rolemodel-skills

Path

skills/document-this/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.