名称: 代码库映射 描述: 生成结构化的代码库地图,包括依赖图、文件关系和架构模式。在探索不熟悉的代码库或记录项目结构时使用。
代码库映射技能
目的
生成一致、结构化的代码库组织文档。
何时使用
- 开始处理不熟悉的项目时
- 新团队成员入职时
- 记录架构决策时
- 在重大重构之前
输出模板
使用 templates/structure-report.md 中的模板
映射过程
步骤 1: 项目识别
从配置文件识别项目类型:
package.json→ Node.jspyproject.toml/setup.py→ Pythongo.mod→ GoCargo.toml→ Rustpom.xml/build.gradle→ Java
步骤 2: 结构分析
映射目录到其目的:
src/或lib/→ 源代码tests/或__tests__/→ 测试文件docs/→ 文档scripts/→ 构建/实用脚本config/→ 配置文件
步骤 3: 依赖图
创建简化的依赖可视化:
入口点
├── 核心模块 A
│ ├── 实用工具 1
│ └── 实用工具 2
├── 核心模块 B
│ └── 外部库
└── 共享组件
步骤 4: 关键文件
识别并记录:
- 入口点 (main.ts, index.js, app.py)
- 配置 (tsconfig, eslint, 等)
- 环境处理
- 构建配置
存储位置
保存输出到: docs/research/codebase-map-{日期}.md