MonitorSystem 技术文档集¶
浙江省大学生创新训练计划项目 ·「摄像头检测系统」的完整技术文档。
文档定位:偏技术、偏事实、偏 bug。给「自己 / 接手者 / 想改代码的人」看。 「给老师看的版本」 → 见仓库根目录的 结题报告.md。
文档地图¶
flowchart TB
START[你来到这里] --> ASK{你的目的?}
ASK -->|「我要跑起来」| RUN[02 环境与运行]
ASK -->|「我要理解系统」| ARCH[03 系统架构]
ASK -->|「我要改 bug」| BUG[08 问题与改进]
ASK -->|「我要冲国创」| DEV[09 开发指南]
ASK -->|「我要写结题材料」| REP[结题报告.md<br/>位于仓库根目录]
ASK -->|「先全面了解」| OVERVIEW[01 项目概览]
OVERVIEW --> RUN
RUN --> ARCH
ARCH --> CODE{看代码细节}
CODE -->|GUI| GUI[04 主程序与 GUI]
CODE -->|检测模块| MOD[05 检测模块]
CODE -->|模型| ML[06 模型与推理]
CODE -->|打包| PKG[07 打包与部署]
GUI --> BUG
MOD --> BUG
ML --> BUG
PKG --> BUG
BUG --> DEV
style REP fill:#FFE4B5,stroke:#FF8C00,stroke-width:3px
style RUN fill:#E0F7FA
style ARCH fill:#E0F7FA
style BUG fill:#FFEBEE
style DEV fill:#E8F5E9
9 篇文档一览¶
| # | 标题 | 核心内容 | 大致字数 |
|---|---|---|---|
| 01 | 项目概览 | 项目身份、技术栈、目录树、规模、时间线 | 中 |
| 02 | 环境与运行 | 装依赖、跑推理、4 种入口方式、故障排查 | 中 |
| 03 | 系统架构 | 7 张 Mermaid 图:架构 / 数据流 / 类关系 / 时序 | 大 |
| 04 | 主程序与 GUI | main.py 849 行逐节解析,按钮回调矩阵 |
大 |
| 05 | 检测模块 | swellcamera + watercamera,含投票算法详解 | 大 |
| 06 | 模型与推理 | 4 个 AgeClassifier 类对比,分类头差异,predict 接口 |
大 |
| 07 | 打包与部署 | PyInstaller spec、Tkinter 钩子、产物结构 | 中 |
| 08 | 问题与改进 | P0/P1/P2 完整清单(4+5+14=23 项),含修复 patch | 大 |
| 09 | 开发指南 | 加新模块、跨平台、国创建议、问 gxl 的清单 | 大 |
阅读路径建议¶
路径 A:完整通读(约 90 分钟)¶
按 01 → 02 → 03 → 04 → 05 → 06 → 07 → 08 → 09 顺序读。适合深度接手的人。
路径 B:结题验收准备(约 45 分钟)¶
- 01 · 项目概览 整体了解 →
- 02 · 环境与运行 跑通推理(演示用) →
- 03 · 系统架构 看图理解 →
- 跳到 结题报告.md 填表
路径 C:调试 bug(约 30 分钟)¶
- 02 · 环境与运行 § 2.5 故障排查 →
- 08 · 问题与改进 找到对应的 PN-N 编号 →
- 按 patch 改代码
路径 D:冲国创(约 60 分钟)¶
仓库根目录的其他文档¶
| 文件 | 用途 |
|---|---|
| 结题报告.md | ⭐ 给老师看的正式材料——项目摘要、技术路线、成果展示 |
| 调研报告.md | 何劭弘 2026-05-14 在 Linux 容器里做的初步代码调研 |
| README.md | gxl 原 README(保留不动) |
文档撰写约定¶
为了保持一致性,所有文档遵循:
- 代码引用:
[filename.py:N](路径#LN)格式,例main.py:117-119 - 跨文档引用:
[标题](./XX-xxx.md)或带锚点[§ 4.3](./04-主程序与GUI.md#43-modulemanager...) - Mermaid 图:嵌入
```mermaid代码块,在 VS Code / GitHub 直接预览 - 严重度标记:🔴 P0 必修 / 🟡 P1 建议修 / 🟢 P2 优化
- 代码补丁:用
```python给出最小变更,附在问题描述之后
文档元信息¶
| 项 | 内容 |
|---|---|
| 撰写日期 | 2026-05-15 |
| 撰写场景 | 省创结题材料准备 |
| 撰写工具 | Claude Code(基于何劭弘的指令) |
| 总字数 | ~30000 字(中文) |
| 总图数 | 9 张 Mermaid 图 |
| 数据来源 | 一手代码阅读 + 微信对话记录 + 教务处通知 |
反馈 / 修订¶
文档发现错误或需要更新:直接在对应 .md 文件上改,git commit 即可。建议每次 commit message 用:
或