对任意代码项目生成一套面向新人的循序渐进文档集,输出到 docs/ 目录。含架构、设计思想、语言特性、代码导读、运行时模型、构建、对接、调试、设计规范共 9 篇,支持全部生成 / 只写几篇 / 更新已有文档。当用户提到"生成项目文档"、"新人文档"、"上手文档"、"架构文档"、"代码导读"、"项目理解"、"深入理解项目"、"onboarding 文档"、"给新同事看的文档"时使用。要按用户给的格式写论文章节、项目梳理、重点问题、简历项目描述的,用 codegen-doc。
Install
npx skills add xstongxue/best-skills --skill project-docsnpx skills add xstongxue/best-skills --skill project-docs -a claude-code -gnpx skills add xstongxue/best-skills --skill project-docs -a codex -ggemini skills install https://github.com/xstongxue/best-skills.git --path skills/project-docsgh skill install xstongxue/best-skills project-docsgit clone --depth 1 https://github.com/xstongxue/best-skills /tmp/xstongxue__best-skills
mkdir -p ~/.claude/skills ~/.agents/skills
cp -R /tmp/xstongxue__best-skills/skills/project-docs ~/.claude/skills/project-docs # Claude Code
cp -R /tmp/xstongxue__best-skills/skills/project-docs ~/.agents/skills/project-docs # Codex, Cursor, Gemini CLI, Copilot, OpenCode