Menu

Individual skill

project-docs

0upvotes

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

skills/project-docs/SKILL.md

Read pinned source

Source commit 9aa4e555950da6e43e7d98c5f0c7b70264204850

What was checked

Matches the observed repository HEAD
Yes
Scanner rules are current
Yes
Repository scan complete
No
Skill scan complete
Yes
Observed behavior
Instructions only
Last checked
Nov 9, 2026

These are observations at the recorded commit, not a guarantee of safety. Review the source before running it.

Install this skill

Choose an agent in your Stack or copy a command below. Commands fetch the pinned commit and copy only this skill directory. Existing destinations are refused. Copying a command does not install anything.

An install command is unavailable: current rules, complete repository and skill scans, an eligible behavior level and a permitted license are required.

Repository context

Repository stars (not skill ratings)
3,162
Repository last updated
Sep 13, 2026
License
Apache-2.0

Observed agent integration: No specific integration evidence. Standard SKILL.md installation does not imply verified compatibility.

Files and excerpt

File metadata and permitted, redacted excerpts come from the recorded scan. Source links are pinned to that commit.

Browse files
Read excerpt

# project-docs：项目深度文档生成

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

## Step 0：判断要做哪种

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

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