CtrlK
BlogDocsLog inGet started
Tessl Logo

project-docs

对任意代码项目生成一套面向新人的循序渐进文档集,输出到 docs/ 目录。含架构、设计思想、语言特性、代码导读、运行时模型、构建、对接、调试、设计规范共 9 篇,支持全部生成 / 只写几篇 / 更新已有文档。当用户提到"生成项目文档"、"新人文档"、"上手文档"、"架构文档"、"代码导读"、"项目理解"、"深入理解项目"、"onboarding 文档"、"给新同事看的文档"时使用。要按用户给的格式写论文章节、项目梳理、重点问题、简历项目描述的,用 codegen-doc。

74

Quality

92%

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

85%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 well-sequenced, highly actionable instruction skill with strong workflow checkpoints, undermined only by progressive-disclosure links that point to non-existent bundle files.

Suggestions

Add the missing reference/ bundle files (explore.md, project-types.md, chapters-01-04.md, chapters-05-09.md, quality.md) so the signaled links resolve.

Until those files exist, inline the essential content from each reference into SKILL.md or remove the broken links.

Trim motivational asides in Phase 3 (e.g., "比没有文档更糟") to recover token efficiency.

DimensionReasoningScore

Conciseness

Mostly lean with tight tables and bullets and no basic-concept padding, but a few motivational asides ("比没有文档更糟", "是新人最容易卡住的地方") could be trimmed.

4 / 5

Actionability

Concrete file names, fixed numbering convention, 300–600 line targets, citation format (src/core/channel.cpp:120-135), and the ⚠️ 未验证 marker give copy-ready guidance; code is not required for this instruction-only skill.

5 / 5

Workflow Clarity

Phase 1→4 sequence with explicit checkpoints: read-before-paste verification, ask-before-overwrite safety for existing docs, and a Phase 4 self-check checklist plus a four-item report-back to the user.

5 / 5

Progressive Disclosure

The body is well-structured with clearly signaled one-level references, but the referenced files (reference/explore.md, project-types.md, chapters-01-04.md, chapters-05-09.md, quality.md) do not exist in the bundle, so navigation is broken.

3 / 5

Total

17

/

20

Passed

Description

100%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, third-person description that concretely states what it produces, enumerates natural trigger phrases, and disambiguates from a related skill. No vague fluff or over-claims.

DimensionReasoningScore

Specificity

Lists nine concrete document types (架构、设计思想、语言特性、代码导读、运行时模型、构建、对接、调试、设计规范) and three explicit operating modes (全部生成/只写几篇/更新已有文档), matching the comprehensive-coverage 5-anchor.

5 / 5

Completeness

Explicitly answers what (生成9篇文档到 docs/) and when ("当用户提到…时使用" with concrete trigger phrases), plus a disambiguation clause routing other cases to codegen-doc.

5 / 5

Trigger Term Quality

Nine natural Chinese trigger phrases including genuine synonyms users would say (新人文档/上手文档/onboarding 文档/给新同事看的文档), giving comprehensive coverage of natural terms.

5 / 5

Distinctiveness Conflict Risk

Clear onboarding-docs niche with distinct triggers and an explicit boundary against the sibling codegen-doc skill, minimizing wrong-skill conflict.

5 / 5

Total

20

/

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.

Validation15 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

relative_links

Relative link issues: 5 missing

Warning

Total

15

/

16

Passed

Repository
xstongxue/best-skills
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.