원클릭으로
project-analyzer
快速分析项目结构、技术栈、核心模块和架构设计,生成完整的中文技术文档。当用户说"分析这个项目"、"生成项目文档"、"我想了解这个代码库"、"帮我理解这个项目的架构"时自动触发。使用 Haiku 子代理并行分析,包含 Mermaid 图表。
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
메뉴
快速分析项目结构、技术栈、核心模块和架构设计,生成完整的中文技术文档。当用户说"分析这个项目"、"生成项目文档"、"我想了解这个代码库"、"帮我理解这个项目的架构"时自动触发。使用 Haiku 子代理并行分析,包含 Mermaid 图表。
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
| name | project-analyzer |
| description | 快速分析项目结构、技术栈、核心模块和架构设计,生成完整的中文技术文档。当用户说"分析这个项目"、"生成项目文档"、"我想了解这个代码库"、"帮我理解这个项目的架构"时自动触发。使用 Haiku 子代理并行分析,包含 Mermaid 图表。 |
| trigger | /analyze-project |
| version | 1.0.0 |
| author | Claude |
快速分析项目的结构、技术栈、核心模块和架构设计,并生成完整的中文技术文档。使用多个 Haiku 子代理并行分析,加快生成速度。
当这个 skill 被触发时,立即按以下步骤执行,不要询问用户:
扫描项目(主线程,1-2 分钟)
启动子代理(并行,在同一个消息中)
agents/ 目录中的 prompt 模板告诉用户
等待子代理完成(10-30 分钟)
生成文档(主线程,5-10 分钟)
质量检查(并行子代理 + 主线程,3-5 分钟)
报告结果
初始化 CLAUDE.md(自动,1-2 分钟)
/init skillAgent 工具并行分析,model: "haiku" 参数用户可以直接说:
/analyze-project [选项]--output <dir> - 指定输出目录(默认:docs/)--depth <level> - 分析深度(quick/medium/deep,默认:medium)--focus <module> - 聚焦特定模块(如:api, services, components)--update - 更新模式:原地更新现有文档,而不是创建新目录在启动子代理之前,先快速扫描项目:
读取配置文件:
package.json、README.md、CLAUDE.mdpnpm-workspace.yaml - pnpm workspacelerna.json - Lernanx.json - Nx检测项目类型:
统计代码规模:
**/*.{ts,tsx,js,jsx}**/*.py**/*.go**/*.java确定分析深度和文档数量:
根据分析深度,启动多个子代理并行探索。重要:在同一个消息中启动所有子代理。
使用 Agent 工具启动 1 个 Haiku 子代理:
agents/core-logic-analyzer.md 获取详细指令。分析项目概览和主要目录结构。报告控制在 200 词以内,中文输出。生成文档:
00-overview.md - 项目总览01-tech-stack.md - 技术栈02-directory-structure.md - 目录结构在同一个消息中并行启动 3 个 Haiku 子代理:
代理 1 - 核心业务逻辑:
agents/core-logic-analyzer.md 获取详细指令。分析 lib/ 或 src/ 目录的核心业务逻辑。报告控制在 300 词以内,中文输出。代理 2 - API 和路由:
agents/api-analyzer.md 获取详细指令。分析 app/api/ 或 pages/api/ 或 routes/ 目录的 API 端点。报告控制在 300 词以内,中文输出。代理 3 - 前端组件:
agents/component-analyzer.md 获取详细指令。分析 components/ 或 views/ 目录的组件结构。报告控制在 300 词以内,中文输出。生成文档:
00-overview.md - 项目总览01-architecture.md - 整体架构02-core-modules.md - 核心模块03-api-reference.md - API 参考04-components.md - 组件结构05-tech-stack.md - 技术栈详解在同一个消息中并行启动 5 个 Haiku 子代理:
等待所有子代理完成后,基于分析结果生成文档:
创建输出目录:
# 检查是否为更新模式
if [ "$UPDATE_MODE" = "true" ]; then
# 更新模式:原地更新,依赖 Git 管理历史
OUTPUT_DIR="docs"
mkdir -p "$OUTPUT_DIR"
if [ -d "docs" ] && [ "$(ls -A docs/*.md 2>/dev/null)" ]; then
echo "更新模式:将更新现有文档(Git 会记录变更历史)"
fi
else
# 快照模式:创建新目录
if [ -d "docs" ] && [ "$(ls -A docs 2>/dev/null)" ]; then
# 如果 docs/ 已存在且非空,创建带时间戳的子目录
OUTPUT_DIR="docs/analysis-$(date +%Y%m%d-%H%M%S)"
mkdir -p "$OUTPUT_DIR"
# 创建 latest 符号链接
ln -sfn "$(basename $OUTPUT_DIR)" docs/latest
echo "检测到 docs/ 已存在,输出到 $OUTPUT_DIR"
echo "最新文档链接: docs/latest/"
else
# 如果 docs/ 不存在或为空,直接使用 docs/
OUTPUT_DIR="docs"
mkdir -p "$OUTPUT_DIR"
fi
fi
为每个文档生成内容:
references/mermaid-guide.md)<!-- 待续 --> 标记分块写入判断:
<!-- 待续 --> 作为分块点文档模板:参考 references/doc-template.md
生成文档后,使用多个 Haiku 子代理并行检查文档质量:
在同一个消息中并行启动 3 个 Haiku 子代理:
代理 1 - 结构与完整性审查员:
agents/structure-reviewer.md 获取详细指令。检查所有生成的文档,验证:
代理 2 - 内容质量审查员:
agents/content-reviewer.md 获取详细指令。检查所有生成的文档,验证:
代理 3 - 图表质量审查员:
agents/diagram-reviewer.md 获取详细指令。检查所有生成的文档,验证:
不要主动输出,等待所有 3 个子代理返回结果。
在子代理检查的同时或之后,主线程执行:
运行验证脚本:
# 验证所有文档的 metadata(使用 skill 目录下的脚本)
python ~/.claude/skills/project-analyzer/scripts/validate-docs.py "$OUTPUT_DIR"
验证内容:
生成文档索引:
在 00-overview.md 中添加完整的文档导航链接
收集所有子代理的审查报告和验证脚本的输出:
分类问题:
修复严重问题:
graph TB 或 flowchart TD 图表记录问题清单:
$OUTPUT_DIR/quality-report.md# 质量检查报告
生成时间:YYYY-MM-DD HH:MM:SS
## 严重问题(已修复)
- [文档名] 问题描述 → 修复方案
## 中等问题(建议修复)
- [文档名] 问题描述
## 轻微问题
- [文档名] 问题描述
## 验证脚本输出
[粘贴 validate-docs.py 的输出]
## 子代理审查摘要
### 结构审查员
[摘要]
### 内容审查员
[摘要]
### 图表审查员
[摘要]
/init skill 不可用或调用失败,记录错误信息/initrequirements.txt、pyproject.toml、setup.pygo.mod、go.sumpom.xml、build.gradleCargo.toml["API 路由"]--> 而不是 ->A["用户登录"] ```mermaid 和 ``` 成对出现graph TB、flowchart TD、sequenceDiagram、classDiagram 等标准类型更新模式(--update):
docs/ 中的文档,依赖 Git 管理历史版本/analyze-project --update快照模式(默认):
docs/analysis-TIMESTAMP/ 新目录,保留所有历史版本/analyze-project(默认)| 场景 | 推荐模式 | 命令 |
|---|---|---|
| 首次分析项目 | 快照模式 | /analyze-project |
| 日常代码更新(Git 项目) | 更新模式 | /analyze-project --update |
| 重大架构调整(需要对比) | 快照模式 | /analyze-project |
| 版本发布前(需要归档) | 快照模式 | /analyze-project |
| 定期维护文档(Git 项目) | 更新模式 | /analyze-project --update |
| 非 Git 项目 | 快照模式 | /analyze-project |
更新模式(依赖 Git):
docs/
├── 00-overview.md # 始终是最新版本
├── 01-architecture.md
├── 02-core-modules.md
└── ...
# Git 历史记录
git log docs/
git diff HEAD~1 docs/00-overview.md # 查看上次更新的差异
快照模式(文件系统保留历史):
docs/
├── analysis-20260414-120000/ # 第一次分析(v1.0)
│ ├── 00-overview.md
│ └── ...
├── analysis-20260420-150000/ # 第二次分析(v2.0)
│ ├── 00-overview.md
│ └── ...
└── latest -> analysis-20260420-150000/ # 符号链接指向最新
检查以下文件/目录:
pnpm-workspace.yaml - pnpm workspaceslerna.json - Lernanx.json - Nxpackages/ 或 apps/ 目录services/ 或 microservices/ 目录对于 Monorepo 或微服务项目:
生成总览文档(00-overview.md):
为每个子包/服务生成独立文档:
docs/
├── 00-overview.md # 总览
├── 01-architecture.md # 整体架构
├── packages/ # 子包文档
│ ├── package-a.md
│ ├── package-b.md
│ └── package-c.md
└── services/ # 服务文档
├── service-auth.md
├── service-api.md
└── service-worker.md
并行分析子包/服务: 为每个子包启动一个 Haiku 子代理
用户说:"分析这个项目"
你的执行步骤:
扫描项目(不输出,1 分钟):
启动 3 个子代理(并行,在同一个消息中):
Agent({ description: "分析核心业务逻辑", model: "haiku", ... })
Agent({ description: "分析 API 路由", model: "haiku", ... })
Agent({ description: "分析前端组件", model: "haiku", ... })
告诉用户: "我正在分析这个项目,已启动 3 个子代理并行分析核心模块、API 和组件。预计 10-15 分钟完成。"
等待子代理完成(10-15 分钟,不输出)
生成文档(5 分钟,分块写入):
质量检查(3-5 分钟,并行子代理):
报告结果:
✅ 分析完成!已生成 6 个中文技术文档:
- [00-overview.md](docs/00-overview.md) - 项目总览
- [01-architecture.md](docs/01-architecture.md) - 整体架构
- [02-core-modules.md](docs/02-core-modules.md) - 核心模块
- [03-api-reference.md](docs/03-api-reference.md) - API 参考
- [04-components.md](docs/04-components.md) - 组件结构
- [05-tech-stack.md](docs/05-tech-stack.md) - 技术栈详解
所有文档包含 Mermaid 图表和代码引用。
质量检查:
- 结构完整性:✅
- 内容准确性:✅
- 图表质量:✅
- 详细报告:[quality-report.md](docs/quality-report.md)
初始化 CLAUDE.md(1-2 分钟):
/init/init 会基于生成的文档创建或更新项目根目录的 .claude/CLAUDE.md/init 调用失败,记录错误但不影响整体流程正在初始化 CLAUDE.md...
详细指南参考 references/ 目录:
references/mermaid-guide.md - Mermaid 图表指南references/doc-template.md - 文档模板子代理的详细指令参考 agents/ 目录:
分析子代理:
agents/core-logic-analyzer.md - 核心业务逻辑分析agents/api-analyzer.md - API 路由分析agents/component-analyzer.md - 前端组件分析质量检查子代理:
agents/structure-reviewer.md - 结构与完整性审查agents/content-reviewer.md - 内容质量与准确性审查agents/diagram-reviewer.md - Mermaid 图表质量审查--focus 深入特定模块或子包--focus 选项model: "haiku")以降低成本docs/ 已存在,创建 docs/analysis-TIMESTAMP/,并创建 docs/latest/ 符号链接--update):原地更新 docs/,依赖 Git 管理历史版本scripts/validate-docs.py 验证文档质量/init - 初始化 CLAUDE.md(分析完成后自动调用)/commit - 提交生成的文档/simplify - 简化生成的文档