第一步:先抓 “宏观信息”,避免直接陷入代码细节
- 优先查看项目 “说明书”
-
必看文件:
README.md:通常包含项目简介、启动方式、环境依赖、核心功能模块等,是最直接的入门指南。docs目录:若存在,里面可能有架构图、数据库设计文档、接口文档(如 Swagger 地址)、业务流程图等,重点关注 “项目是做什么的”“核心业务流程是什么”。CHANGELOG.md:了解项目迭代历史,快速定位当前版本的核心功能和改动点。
-
若文档缺失: 查看项目的
issue列表(如 GitLab/GitHub 的 issues)、合并记录(MR/PR),或询问同事核心功能模块的负责人,减少盲目摸索时间。
边对着可视化的界面,边比对文档,输出理解的 项目整体情况,不理解的地方整理出来问导师
- 确认项目 “技术栈” 和 “环境依赖”
快速明确项目用了哪些技术,避免因环境问题卡壳
验证完毕 √