code-documentation

Use this skill when the user requests to generate, create, or improve documentation for code, APIs, libraries, repositories, or software projects. Supports README generation, API reference documentation, inline code comments, architecture documentation, changelog generation, and developer guides. Trigger on requests like "document this code", "create a README", "generate API docs", "write developer guide", or when analyzing codebases for documentation purposes.

Quality

79%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

Securityby

Passed

No findings from the security scan

Fix and improve this skill with Tessl

tessl review fix ./skills/public/code-documentation/SKILL.md

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 content is well-structured and actionable with a clear phased workflow, but it is verbose and inlines large boilerplate templates that would benefit from separation into reference files. No progressive disclosure through bundle files is used.

Suggestions

Move the large README, API reference, and architecture markdown templates into separate reference files (e.g. templates/README.md) and link to them one level deep to improve progressive disclosure and reduce token load.

Trim explanations of conventions Claude already knows (ATX headers, PEP 257, TypeDoc) to lean pointers; keep only the project-specific structure.

Add an executable validation/rebuild feedback loop (e.g. re-read generated docs against source and fix mismatches) to strengthen the QA phase beyond a passive checklist.

Dimension	Reasoning	Score
Conciseness	Mostly efficient with concrete templates, but the body includes extensive boilerplate README/API/architecture templates and explanations of conventions Claude already knows (e.g. PEP 257, ATX headers) that could be tightened.	3 / 5
Actionability	Provides concrete, mostly executable templates and code blocks (bash exploration commands, docstring examples) with minor gaps where placeholders remain.	4 / 5
Workflow Clarity	Clear three-phase sequence with steps and a quality-assurance checklist, though validation checkpoints are review-style checks rather than executable validate->fix->retry loops.	4 / 5
Progressive Disclosure	Single monolithic SKILL.md with no bundle files or one-level-deep references; large template blocks that could live in separate reference files are inlined, so structure is only moderate.	3 / 5
	Total	14 / 20 Passed

Description

95%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 specific, complete, and well-differentiated with explicit trigger phrases and concrete capability listing. It uses third person voice and avoids vague language.

Dimension	Reasoning	Score
Specificity	Lists multiple concrete documentation actions (README generation, API reference, inline comments, changelog generation) plus specific formats, with minor gaps in coverage.	4 / 5
Completeness	Clearly states what it does ('generate, create, or improve documentation...') and explicit when to use it with concrete trigger phrases and 'Trigger on requests like' guidance.	5 / 5
Trigger Term Quality	Comprehensive natural trigger phrases including quoted phrases ('document this code', 'create a README', 'generate API docs', 'write developer guide') and relevant synonyms.	5 / 5
Distinctiveness Conflict Risk	Clear niche (code documentation) with specific file-type and output triggers (README, API reference, changelog), minimal overlap risk with other skills.	5 / 5
	Total	19 / 20 Passed

Validation

93%

Warnings & errors only

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

Criteria	Description	Result
relative_links	Relative link issues: 2 missing	Warning

	Total	15 / 16 Passed

Repository: bytedance/deer-flow
Path: skills/public/code-documentation/SKILL.md
Commit: 2a261d2

Reviewed: about 17 hours ago

Table of Contents

Discovery Implementation Validation

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.