# Onboard Codebase With AI

> 帮助开发者理解陌生代码库、在本地启动项目、追踪一条业务流程，并分析第一个小需求的影响范围。适用于接手新软件项目、交接文档不完整、需要定位某个业务动作的相关代码，或准备在修改代码前制定安全可靠的变更方案。

- Skill: `aikingw/onboard-codebase-with-ai` (Agent Skill, multi-file: 3 files)
- Install (CLI): `npx skillmds@latest add aikingw/onboard-codebase-with-ai`
- Raw SKILL.md: https://api.skillmd.com/api/skills/aikingw/onboard-codebase-with-ai/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: aikingw (https://skillmd.com/u/aikingw)
- Updated: 2026-09-22
- Page: https://skillmd.com/skills/aikingw/onboard-codebase-with-ai

---


# 使用 AI 快速上手代码项目

修改代码前，先建立一份有证据的项目地图。AI 输出只能作为候选结论，必须通过代码文件、运行命令、测试结果或项目成员确认。

## 工作流程

### 1. 检查权限和安全边界

确认当前代码库属于用户授权范围，并确认当前 AI 工具可以处理该项目代码。不得暴露密钥、生产配置、客户数据或个人信息。如果使用权限不明确，停止并向用户确认。

### 2. 建立项目地图

按顺序查看：

- README 和项目文档
- 两层目录结构
- 构建文件和依赖文件
- 配置样例
- 应用启动入口
- 测试目录

整理项目模块、模块职责和启动线索。每条事实结论都必须附文件路径。没有足够证据的结论标记为“待确认”。

### 3. 启动项目

根据仓库中的文档、构建文件和配置整理运行条件与启动命令。只执行安全、正常且属于任务范围的项目命令，并记录真实运行结果。不能因为命令看起来正确，就声称项目已经成功运行。

### 4. 追踪一条业务流程

如果用户没有指定业务动作，询问一个具体动作，例如“创建订单”。每次只追踪一条流程：

```text
入口 → 业务服务 → 数据访问 → 消息或外部接口
```

每一步都附文件路径和类、函数或配置项。遇到反射、动态配置或运行时路由时，标记为“需要运行验证”。

### 5. 分析第一个需求

修改代码前，先输出候选影响清单：

- 需求中的歧义和待确认规则
- 可能修改的文件和代码位置
- 数据库、缓存、消息和外部接口影响
- 正常、边界和失败场景的测试
- 发布与回滚风险

除非用户同时要求实现，否则只做分析，不修改代码。所有候选改动都要回到代码中核验。

## 输出要求

使用 [references/output-template.md](references/output-template.md) 中的模板。报告保持简洁，并明确区分：

- `已验证`：有文件、命令、测试或项目成员确认
- `推断`：有一定依据，但尚未完成验证
- `待确认`：缺少证据，或需要用户、项目成员做决定

最后给出一个最小且明确的下一步行动。没有真实计时数据时，不得声称节省了具体时间或比例。