基于当前项目/代码生成各类文档,支持论文章节、项目梳理、重点问题、简历项目描述四种类型。当用户提到生成论文章节、项目梳理、技术难点、简历项目描述时使用。要给新同事看的上手文档(新人文档、架构文档、代码导读、onboarding)用 project-docs。
66
79%
Does it follow best practices?
Run evals on this skill
Adds up to 20 points to the overall score
View guide
Passed
No findings from the security scan
Fix and improve this skill with Tessl
tessl review fix ./skills/codegen-doc/SKILL.md本 Skill 指导 Agent 基于当前项目/代码仓库生成各类文档,支持四种类型:论文章节、项目梳理、重点问题、简历项目描述。
| 用户表述 / 关键词 | 执行 |
|---|---|
| 论文章节、系统设计、总体设计、详细设计 | reference/thesis-chapter.md |
| 项目梳理、项目文档结构、按格式梳理 | reference/overview.md |
| 重点问题、技术难点、待解决问题、项目风险 | reference/key-issues.md |
| 简历项目描述、项目经历、按简历格式 | reference/resume-format.md |
不属于这四种的情况:用户要的是给新同事看、能照着上手的项目文档(新人文档、架构文档、代码导读、onboarding),用 project-docs。本 Skill 产出的是按对方指定格式写、给导师/评委/HR/领导看的东西。
四种类型都要先读代码。不要试图读完所有源文件,分三步:
node_modules / build / dist / vendor)、构建和依赖文件(package.json / pom.xml / requirements.txt / go.mod 等)、README,得出项目干什么、用什么技术栈TODO / FIXME、README 的 Known issues / Limitations、异常处理和兜底逻辑技术栈、模块名、接口名要和代码逐字一致,不要凭印象改写。
88a38bb
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.