project-docs

Installation
SKILL.md

project-docs:项目深度文档生成

输出到项目的 docs/ 目录。核心约束:文档里的代码、类名、路径都必须来自真实文件,见 Phase 3。

Step 0:判断要做哪种

用户表述 做什么
生成项目文档 / 新人文档 / 深入理解项目(没指定篇目) 全部生成,Phase 1 → 2 → 3 → 4
帮我写架构文档 / 只要代码导读 / 写构建和调试 只写指定的几篇,读项目的范围可相应缩小
代码改了,更新文档 / 文档过期了 docs/.project-map.md,比对现在的代码,只重写受影响的篇目

docs/ 已经有内容时:先列出已有文件,问用户是覆盖、跳过已存在的、还是备份到 docs.bak/。不要直接盖掉。

不该用这个 skill 的情况:用户要的是论文章节、项目梳理、重点问题清单、简历项目描述——也就是给导师、评委、HR、领导看,且格式由对方指定的东西,用 codegen-doc。这个 skill 只管给新同事看、要能照着上手的文档。


Phase 1:先读项目,把结果记下来

Installs
15
GitHub Stars
2.8K
First Seen
Jul 20, 2026
project-docs — xstongxue/best-skills