CtrlK
BlogDocsLog inGet started
Tessl Logo

project-docs

对任意代码项目生成一套面向新人的循序渐进文档集,输出到 docs/ 目录。包含架构、设计思想、代码导读、运行时模型、构建系统、对接指南、调试指南、语言特性、设计规范共 9 篇。当用户提到"生成项目文档"、"写文档"、"新人文档"、"项目理解"、"深入理解项目"时使用。

67

Quality

81%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

SecuritybySnyk

High

Do not use without reviewing

SKILL.md
Quality
Evals
Security

Quality

Content

62%

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 with a clear phased workflow and explicit validation, but it suffers from a broken reference to a missing reference.md and some redundancy between the exploration bullets and the prompt template. Tightening the overlap and providing the referenced templates would raise quality.

Suggestions

Create the missing reference.md (or remove the dangling link) so the promised document templates are actually available — the broken reference currently undermines both actionability and progressive disclosure.

Deduplicate Phase 1: either keep the exploration-target bullet list or the '提示词参考' prompt block, not both, since they cover the same ground.

Trim the Phase 4 checklist items that merely restate the Phase 2 ordering rule, keeping only the genuine post-generation verification checks.

DimensionReasoningScore

Conciseness

The body is mostly lean and avoids explaining concepts Claude already knows, but the Phase 1 bullet list of exploration targets and the immediately following '提示词参考' code block substantially overlap, and the Phase 4 checklist partly repeats earlier ordering guidance — it could be tightened.

2 / 3

Actionability

It gives concrete specifics (nine named filenames, a fixed per-doc structure, explicit writing techniques and taboos), but the detailed templates that would make guidance fully copy-paste ready are deferred to reference.md, which does not exist, leaving a gap between instruction and execution.

2 / 3

Workflow Clarity

A clear four-phase sequence (explore → order → write → verify) with an explicit post-generation validation checklist in Phase 4, plus a reinforced ordering constraint (language-concepts doc before code walkthrough) and a skip/renumber rule, matching the 'clear sequence with explicit validation steps and checklists' anchor.

3 / 3

Progressive Disclosure

The body is well-sectioned and signals an external reference ('详细模板见 [reference.md](reference.md)'), but that file is absent — no references/ directory or reference.md exists — so the one-level-deep reference is broken and the detailed template content it promises is unavailable.

2 / 3

Total

9

/

12

Passed

Description

100%

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, third-person, and complete: it enumerates concrete deliverables, a concrete output location, and explicit natural-language triggers. It cleanly satisfies all four dimensions with no verbosity or over-claims.

DimensionReasoningScore

Specificity

Lists multiple concrete actions — generating nine specifically named documents (架构/设计思想/代码导读/运行时模型/构建系统/对接指南/调试指南/语言特性/设计规范) and outputting them to a concrete docs/ directory, matching the 'lists multiple specific concrete actions' anchor.

3 / 3

Completeness

Explicitly states both what it does (generate a progressive 9-doc set into docs/) and when to use it ('当用户提到...时使用'), satisfying the 'clearly answers both what AND when' anchor.

3 / 3

Trigger Term Quality

Provides a rich set of natural user phrases — '生成项目文档', '写文档', '新人文档', '项目理解', '深入理解项目' — covering the common ways a user would request this skill.

3 / 3

Distinctiveness Conflict Risk

Has a clear niche (beginner-oriented progressive project documentation, 9 fixed docs) with distinct triggers, making overlap with other skills unlikely.

3 / 3

Total

12

/

12

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: 1 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.