菜单
EDITH 分支 Skill。为无文档的老项目（棕色地带项目）生成 AI 可消费的文档骨架。扫描代码提取业务模型、接口信息、数据架构、技术栈等。填补 EDITH INVENTORY 阶段中"老项目无文档可盘点"的缺口。支持全局扫描和模块深入两种模式。
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
| name | edith-document-project |
| description | EDITH 分支 Skill。为无文档的老项目（棕色地带项目）生成 AI 可消费的文档骨架。扫描代码提取业务模型、接口信息、数据架构、技术栈等。填补 EDITH INVENTORY 阶段中"老项目无文档可盘点"的缺口。支持全局扫描和模块深入两种模式。 |
EDITH 的分支 Skill，填补黄金路径 Phase 2 INVENTORY 阶段的核心缺口：公司有老项目但没有文档，Agent 无从盘点。本 Skill 从代码本身逆向提取信息，让无文档的老项目也能被 EDITH 纳入盘点。
EDITH 黄金路径：
Phase 1 CLARIFY → 明确为什么需要 EDITH
Phase 2 INVENTORY → 盘点资产、仓库、流程
├─ 2a. 盘点已有文档和数字资产（原流程）
├─ 2b. 对无文档老项目运行本 Skill（代码考古） ← 你在这里
└─ 2c. 蒸馏压缩后生成技能种子（→ distillator）
Phase 3 CLASSIFY → 分类哪些可以自动生成
Phase 4 SCAFFOLD → 生成骨架
Phase 5 BOOTSTRAP SKILLS → 生成技能骨架
Phase 6 CONFIRM → 人工确认
Phase 7 PILOT-READY → 试点就绪
Phase 8 GROW BY WRITEBACK → 通过回写成长
本 Skill 的产出 → EDITH 三层技能的种子：
| 本 Skill 的输出 | 对应的 EDITH 技能层 | 用途 |
|---|---|---|
| API 契约 + 数据模型 | Repo Skill | Agent 需要知道仓库暴露了什么接口和数据结构 |
| 业务逻辑 + 集成架构 | Workflow Skill | 从 Service 调用链反推跨仓库业务流程 |
| 项目概览 + 技术栈 | Source Skill | 帮助 Agent 路由到正确的仓库 |
| 源码树 + 开发指南 | Repo Skill | "我在哪？这个仓库干什么？怎么验证？" |
| 模块深入文档 | Repo Skill 完整版 | 逐文件级别的操作指南 |
[未确认]，绝不编造本 Skill 生成的是 Scaffold（骨架），不是 Mature Knowledge（成熟知识）。
这是本 Skill 与 EDITH 理念对齐的核心纪律：
本 Skill 的产出（Scaffold）
↓ EDITH Phase 6: 人工确认事实字段
↓ EDITH Phase 7: 试点就绪
↓ EDITH Phase 8: 真实工作中 START → WORK → END 回写
↓
Mature Knowledge（EDITH 的组织记忆）
绝对不要把 Scaffold 当作 Mature Knowledge 交付。
当用户说：
向用户确认：
{项目路径}/docs/）将项目中已有的 MD 文档从"补充信息"提升为"一等知识源"，按分级策略深入分析。
| 级别 | 文档类型 | 处理策略 | 示例 |
|---|---|---|---|
| P0 必读 | README.md, CHANGELOG.md, CONTRIBUTING.md | 全量读取，提取所有事实 | 根目录 README |
| P1 高优 | docs/ 目录下的架构/API/设计文档 | 按相关性评分，高分全量读 | docs/architecture.md |
| P2 标准 | 其他目录下的 MD 文件 | 建索引 + 提取标题和首段 | guides/, examples/ 下 |
| P3 跳过 | node_modules/ 等第三方目录 | 跳过 | 第三方库 README |
将 MD 提取的事实与代码分析结果对比：
[文档-代码不一致]扫描项目根目录，检测：
| 检测项 | 方法 |
|---|---|
| 项目类型 | 关键文件：package.json → web/node, go.mod → Go, requirements.txt → Python 等 |
| 项目结构 | monolith / monorepo / multi-part（如 client+server） |
| 主要语言 | 从文件后缀统计 |
| 框架 | 从依赖中提取（Express, Spring, Django, Gin 等） |
12 种项目类型识别：web, mobile, backend, cli, library, desktop, game, data, extension, infra, embedded, custom
向用户展示检测结果，确认后继续。
对每个子项目/模块：
立即写入 docs/tech-stack.md
从"目录级条件扫描"升级为"函数级全量分析"，在深度策略控制下按语言提取代码知识。
| 语言 | 提取内容 |
|---|---|
| TypeScript/JS | export function 签名、interface/type/class/enum 定义 |
| Go | func 签名（含方法接收器）、struct/interface 定义 |
| Python | def 签名（含 type hints）、class 定义 |
| Java | method 签名、class/interface/enum 定义 |
分析文件级 import/export 关系：
| 模式类型 | 识别方法 |
|---|---|
| 错误处理 | XxxError 类定义、throw/catch 模式 |
| 设计模式 | Factory（create 方法）、Strategy（策略接口）、Observer（事件）、Middleware（use/next） |
| 副作用 | HTTP 调用、数据库操作、文件 I/O |
| 配置消费 | process.env、config.get、环境变量列表 |
| 条件 | 扫描内容 |
|---|---|
| 有 routes/controllers/ | API 路由和端点 |
| 有 models/schemas/ | 数据模型和数据库 Schema |
| 有 components/ui/ | UI 组件清单 |
| 有 services/handlers/ | 业务逻辑层 |
| 有 middleware/ | 认证鉴权模式 |
| 有 migrations/ | 数据库迁移历史 |
| 有 .github/workflows/ | CI/CD 流水线 |
| 有 Dockerfile | 部署架构 |
立即写入 docs/api-contracts.md
立即写入 docs/data-models.md
立即写入 docs/business-logic.md
生成带注释的目录树：
立即写入 docs/source-tree.md
综合所有扫描结果，生成架构文档：
立即写入 docs/architecture.md
提取开发相关信息：
立即写入 docs/development-guide.md
创建 docs/index.md 作为 AI Agent 的入口：
立即写入 docs/index.md
针对某个微服务或模块做逐文件详尽分析。
向用户展示可深入的区域（根据全局扫描结果）：
也接受自定义路径。
必须全文阅读，禁止跳过。 对每个文件提取：
文件路径：完整路径
用途：1-2 句话说明
代码行数：LOC
导出：
- functionName(param: Type): ReturnType — 说明
- ClassName — 说明 + 关键方法
- Type/Interface — 说明
依赖：import 了什么，为什么
被依赖：谁 import 了这个文件
关键实现：重要逻辑、算法、模式
副作用：API 调用、数据库查询、文件 I/O
错误处理：try/catch、错误边界
测试：关联的测试文件和覆盖情况
TODO/FIXME：行号 + 内容
生成 docs/deep-dive-{module-name}.md，包含：
更新 docs/index.md 添加 deep-dive 链接。
scan 根据项目规模和架构自动选择最优深度，无需用户手动选择。
规模 → 深度映射：
| 项目规模 | 源文件数 | 自动深度 | 行为 |
|---|---|---|---|
| small | <100 | Exhaustive | 全量读取所有源文件 |
| medium | 100–500 | Deep | 读关键目录 + 高价值文件 |
| large | 500–2000 | Deep | 自动识别模块边界，按模块分批扫描 |
| xlarge | >2000 | Deep | 按模块分批扫描，合并生成全局文档 |
架构感知调整：
| 架构 | 自动深度 | 说明 |
|---|---|---|
| monolith | 按规模映射 | 单模块，整体扫描 |
| monorepo | Deep | 按子 package/app 分模块扫描 |
| microservice | Deep | 按服务分模块扫描 |
| multi-part | Deep | client/server 分层扫描 |
手动覆盖： 用户可通过 --depth=quick|deep|exhaustive 参数覆盖自动选择。
| 级别 | 方式 | 适用场景 |
|---|---|---|
| Quick | 只看目录结构和配置文件 | 快速了解项目概貌 |
| Deep | 读关键目录中的文件 | 准备做 brownfield PRD |
| Exhaustive | 读全部源文件 | 完整分析、迁移规划 |
当扫描大量文件时，按子目录分批处理：
每批完成后更新状态文件 docs/.scan-state.json，支持中断恢复。
docs/
├── index.md # 主索引（AI 入口）
├── project-overview.md # 项目概览
├── tech-stack.md # 技术栈
├── architecture.md # 架构文档
├── source-tree.md # 源码树分析
├── api-contracts.md # API 契约（如适用）
├── data-models.md # 数据模型（如适用）
├── business-logic.md # 业务逻辑（如适用）
├── development-guide.md # 开发指南
├── deep-dive-{module}.md # 模块深入（按需）
├── integration-architecture.md # 集成架构（如多模块）
└── .scan-state.json # 扫描状态（用于恢复）
必须停止并询问用户的情况：
绝对禁止：
完成前必须确认：
[未确认]