明早和 gxl 对接前的阅读路径¶
撰写场景:何劭弘(hsh)将与项目主开发者龚馨铃(gxl)对接结题事宜。 目标:在最少阅读时间内,让 hsh 能听懂 gxl 说话 + 知道该问什么 + 知道该从 gxl 拿什么材料。 撰写日期:2026-05-15 文档分类:行动文档(action doc),结题流程结束后可归档。
🚀 快速版(30-40 分钟)— 目标:能听懂 gxl 说话 + 知道该问什么¶
只读这些,按顺序:
| # | 文件 | 时长 | 目的 |
|---|---|---|---|
| 1 | 调研报告.md | 5 min | 你自己写的,复习一下当时的发现 |
| 2 | 01-项目概览.md § 1.2 + § 1.4 | 3 min | 项目在做什么 + 仓库长什么样 |
| 3 | 03-系统架构.md § 3.1, 3.2, 3.3 | 10 min | 只看三张 Mermaid 图,跳过文字 |
| 4 | 05-检测模块.md § 5.3, 5.11 | 8 min | 标签对调 + 投票算法——两个明天必谈的话题 |
| 5 | 08-问题与改进.md § 8.0 速览表 | 3 min | 扫一眼 23 项问题 |
| 6 | 09-开发指南.md § 9.11 | 5 min | ⭐ 8 个必问问题,复制到微信对话框预置 |
| 7 | 结题报告.md 通读 <待补> 字段 |
5 min | 知道明天该从 gxl 拿什么材料 |
对接产出:手上有 8 个必问问题 + 一份待补字段清单 + 听得懂 gxl 提及的术语(model1~4、投票、label_mapping、模型权重)。
📚 完整版(2.5–3 小时)— 目标:你来主导,gxl 只补缺¶
按依赖关系顺序:
| 阶段 | 文档 | 时长 | 备注 |
|---|---|---|---|
| 0. 复盘 | 调研报告.md | 10 min | 你的旧调研 |
| 1. 入门 | 01-项目概览.md | 10 min | 全读 |
| 2. 运行 | 02-环境与运行.md | 10 min | 略读,明白入口的 4 种方式 |
| 3. 架构 | 03-系统架构.md | 20 min | 每张 Mermaid 图都看清 |
| 4. 主程序 | 04-主程序与GUI.md | 20 min | 重点 § 4.3 ModuleManager + § 4.6 按钮回调矩阵 |
| 5. 检测算法 | 05-检测模块.md | 30 min | ⭐ 最核心的一篇,全读 |
| 6. 模型层 | 06-模型与推理.md | 20 min | 重点 § 6.3 分类头对比、§ 6.5 predict 接口分歧 |
| 7. 打包 | 07-打包与部署.md | 10 min | 略读,知道 spec/hook 三处冗余即可 |
| 8. Bug 清单 | 08-问题与改进.md | 25 min | 全读,特别 § 8.5 修复执行顺序 |
| 9. 延续路线 | 09-开发指南.md | 20 min | 重点 § 9.7 国创建议、§ 9.11 问 gxl 清单 |
| 10. 对外材料 | 结题报告.md | 15 min | 全读,记下所有 <待补> |
| 11. 一手代码(选读) | main.py、swellcamera/swellcamera.py、watercamera/watercamera.py、models/model4.py | 30-45 min | 文档+代码对照看,确认你信得过文档 |
⏱ 时间不够时的取舍建议¶
| 可用时间 | 怎么读 |
|---|---|
| 只有 20 分钟 | 跳到快速版的 #4 + #6 + #7(标签对调 / 投票算法 + 问 gxl 清单 + 待补字段)。其他临场用得上时再翻。 |
| 有 1 小时 | 走快速版 + 加 05 全读 + 08 § 8.1(4 个 P0)。 |
| 有半天 | 走完整版。 |
🛠 对接 gxl 时的工具书(建议提前开好这几个标签页)¶
- 09-开发指南.md § 9.11 — 一边聊一边在旁边记答案
- 结题报告.md — 一边聊一边补
<待补> - 05-检测模块.md § 5.3 — gxl 提到"模型/标签"时随时翻
- 06-模型与推理.md § 6.3 — gxl 提到"训练时的分类头"时随时翻
📌 备忘:对接产出的归宿¶
聊完后,把答案落到这些地方:
| 拿到什么 | 写到哪 |
|---|---|
| 项目编号、立项日期、成员分工等元信息 | 结题报告.md 第一节"项目基本信息"的 <待补> |
| 数据集规模、训练 epoch、训练超参 | 结题报告.md § 4.3 |
| 各模型验证集准确率/F1 | 结题报告.md § 7.3 |
| 团队竞赛证书、论文清单 | 结题报告.md § 7.5 |
| label_mapping 标签对调的原因 | 在 08-问题与改进.md § P0-4 末尾加一行"gxl 确认:..." |
| ReLU 被替换为 Identity 的原因 | 在 08-问题与改进.md § P2-14 末尾加一行"gxl 确认:..." |
| 训练脚本、数据集存放位置 | 在 01-项目概览.md § 1.8 表格里补 |
聊完后立刻 git commit -m "docs: 补充 gxl 对接后的项目元信息",趁记忆新鲜。