# Project Onboarding

> 快速理解陌生代码库的目标、结构、运行方式、验证入口和高风险边界，形成可执行的项目地图。

- Skill: `lakernote/project-onboarding` (Agent Skill)
- Install (CLI): `npx skillmds@latest add lakernote/project-onboarding`
- Raw SKILL.md: https://api.skillmd.com/api/skills/lakernote/project-onboarding/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: lakernote (https://skillmd.com/u/lakernote)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/lakernote/project-onboarding

---


# Project onboarding

1. 先读取根目录 README、依赖清单、构建配置、CI 配置和一层目录结构；不要一开始递归读取整个仓库。
2. 用代码和配置互相校验项目定位、语言与框架、启动入口、持久化、外部依赖、环境变量和发布方式，README 只能作为线索，不能作为唯一事实。
3. 找出测试、格式化、静态检查和构建命令；未经用户要求不要安装依赖、修改文件或启动长期进程。
4. 标记服务边界、数据目录、鉴权、密钥、并发写入、迁移和部署等高风险区域，并给出对应文件路径作为证据。
5. 若仓库很大，先用 `find`、`ls`、`grep` 和 `read` 缩小范围；只有需要执行项目命令时再用 `shell`。
6. 最终输出项目解决的问题、架构地图、关键入口、开发与测试命令、已确认风险、仍待确认事项，以及最值得继续阅读的 3–5 个文件。