CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

code-documentation-doc-generate

Compatibility alias of documentation-generation-doc-generate. Generate scoped documentation from verified source while preserving existing callers of this ID.

Quality

64%

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/code-documentation-doc-generate/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

63%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 well-structured, lean, and includes explicit validation checkpoints plus a concrete worked example, giving solid workflow clarity and token efficiency. It is held back by abstract core instructions with no executable commands and by its only progressive-disclosure reference pointing to a playbook that is missing from the bundle.

Suggestions

Ship the referenced `resources/implementation-playbook.md` (or remove the reference and the "bundled playbook" claim), so the primary disclosure path is not a dead link.

Add one or two concrete commands to the worked example, e.g. the actual schema/doc build command and the read-only verification call, so the validation checkpoints are executable rather than descriptive.

Trim the alias-maintenance section to a one-line note and consolidate the three separate mentions of the playbook into the Resources section to reclaim tokens.

DimensionReasoningScore

Conciseness

The body is compact, uses well-labeled sections, and does not explain concepts Claude already knows. Minor trimmable material remains: the maintenance section's time-stamped line ("Modified in AAS on 2026-09-05; original metadata and license notices are retained") and the playbook being referenced three times (Instructions, Worked example, Resources). Fits anchor 4 (efficient, minor over-explanation) rather than 5, since those tokens don't earn their place at execution time.

4 / 5

Actionability

The worked example and acceptance criteria add concreteness (cursor field name, final-page value, invalid-cursor response, run/failed/unrun reporting), but the core instructions are high-level ("Extract information from code, configs, and comments", "Generate docs with consistent terminology and structure") with no commands, tooling, or paths a reader could execute. Fits anchor 3 (some concrete guidance but incomplete) rather than 4, which requires concrete code or commands with only minor gaps.

3 / 5

Workflow Clarity

The worked example sequences the process (inspect implementation and fixtures, update example and explanation, run schema/doc build and the documented read-only call, record what ran) and validation checkpoints are explicit ("Validate generated examples against actual routes and the current build"; report checks "as run, failed or unrun with a reason"). Fits anchor 4 (clear sequence, most checkpoints, minor gaps); not 5 because no error-recovery loop or concrete commands are given, and not 3 because validation is explicitly present rather than implicit.

4 / 5

Progressive Disclosure

Sections are clearly organized and the playbook reference is prominently signaled in a dedicated Resources section, but the referenced file `resources/implementation-playbook.md` does not exist anywhere in the bundle (no references/, scripts/, assets/, or resources/ directories), making the primary disclosure path a dead link that the body even describes as "bundled". Falls between anchors 3 and 4: structure and signaling are good, but navigation fails because the one-level-deep reference is dangling.

3 / 5

Total

14

/

20

Passed

Description

50%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 dominated by alias-maintenance metadata, leaving a single stated capability and no trigger guidance. It answers "what" only partially and "when" not at all, so every dimension lands at the midpoint. Adding an explicit use-when clause and one or two more concrete actions would lift it materially.

Suggestions

Add an explicit trigger clause, e.g. "Use when asked to generate or update API, architecture, or user documentation from a codebase, or when standardizing docs across a repository."

Replace some alias metadata with 2-3 concrete actions, e.g. "Generate scoped API/architecture/user docs, extract terminology from code and configs, and validate examples against the current build."

Reduce conflict risk by making the alias line secondary (e.g. a trailing note) and leading with the distinguishing capability and triggers, since the canonical ID already shares this purpose.

DimensionReasoningScore

Specificity

"Generate scoped documentation from verified source" names the domain and one concrete action, but the rest of the description ("Compatibility alias of documentation-generation-doc-generate... preserving existing callers of this ID") is alias-maintenance metadata rather than capability. Matches anchor 3 (domain plus 1-2 concrete actions, not comprehensive); not 4 because only one specific action is listed.

3 / 5

Completeness

The "what" is stated ("Generate scoped documentation from verified source") but there is no "Use when..." clause or any trigger guidance; per the judging guidelines a missing 'Use when...' caps completeness at 3. Not 2 because the what is reasonably clear, not 4 because the when is entirely absent rather than merely imprecise.

3 / 5

Trigger Term Quality

Relevant keywords like "documentation", "generate", and "source" appear, but common user phrasings ("write API docs", "document this code", "README", "user guide", "docs") and their variations are absent. Anchor 3 (some relevant keywords, missing variations) fits better than 2, since more than one or two domain-relevant terms are present, and better than 4, since coverage is thin.

3 / 5

Distinctiveness Conflict Risk

"Compatibility alias of documentation-generation-doc-generate" explicitly declares a second skill ID with the same capability, guaranteeing trigger overlap with its own twin; the doc-generation domain itself is somewhat specific. Fits anchor 3 (somewhat specific, could overlap with similar skills) rather than 4, because the alias relationship is a built-in conflict, and rather than 2, because the domain is not extremely broad.

3 / 5

Total

12

/

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

sickn33/agentic-awesome-skills

Path

skills/code-documentation-doc-generate/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.