docs: 任务规划目录收缩——只留推进顺序与硬件缺陷,其余待办归模块文档
按用户裁定(2026-11-10)把 docs/任务规划/ 从"全量待办表"收成两个文件: 1. 登记簿.md 只记 V0.1 硬件缺陷 → V0.2 改版要求(双转换器无共同采样触发、 IA 前端差分滤波限制谐波带宽)。原 §1/§2/§4/§5/§6/§7/§8/§9 的待办按 "待办跟着所属模块走"清空,四类事实在删除前先落到新归属: - 两点标定开工前要先拍板的三件事 → 算法层设计说明 §13.13(新节) - 通讯设置页真机判据 → 网络配置说明 §3.6 内联 - 缩堆迁 CCM 后半、开入开出重开条件 → 原本各模块文档即唯一权威 2. 暂缓-RS485.md 删除,其唯一不可丢的"采集链路测试可验证性约束"三条与 完成判据并入 产品需求设计文档 §5.10。 3. 任务规划/README.md 去掉全部历史叙述(UI 补齐销项流水、net 收口过程、 故障录波近千字台账),只留:怎么用、条目规则、生成物单写者纪律、 推进顺序表(每行只写当前状态与卡点)、维护约定。 同步改写全库引用(约 60 处):AGENTS.md、docs/README.md、产品需求、UI、 子系统设计、内存管理、环境与部署、算法、测试说明、门禁说明、问题记录, 以及 App/ 与 Drivers/BSP/ 的头注释、脚本与 .pre-commit-config.yaml 注释。 顺带修掉三处已失效的引用目标:链路延迟测试的队列往返重验项改指实机测试 实施指南 §7.3;并行工作树的 <ID> 行去掉已退役的 N-x/S-x/T-x 编号族; 任务规划 README 的 §1 旧编号在技能示例里的引用。 门禁:check_doc_links --all --sections-strict 214 篇通过、无法判定 0; pre-commit 全 Passed(doc-links / mermaid / 任务表 / 内存数字 / BOM / UI 像素回归 / generated-fresh / layer-deps / bsp-err / skill-size); keil-build 0 错误 0 警告(Code=255160 RO=31204 RW=2080 ZI=152152), RAM 预算门禁 PASS(RW_IRAM1 73.9%、RW_CCM 87.9%)。
This commit is contained in:
+7
-7
@@ -11,7 +11,7 @@
|
||||
```
|
||||
docs/
|
||||
├── README.md 本索引(阅读顺序 + 全量清单)
|
||||
├── 任务规划/ 统一待办(README 单一入口 + 2 个职责文件)
|
||||
├── 任务规划/ 全项目顺序 + 硬件缺陷登记簿
|
||||
├── 产品需求/ 产品需求设计文档(需求基线)+ 参考产品复刻明细(逐项差额)
|
||||
├── 架构设计/ 全局架构与设计方法论(含 软件架构与运行时规格 / 硬件规格与能力边界:位表与引脚权威)
|
||||
├── 子系统设计/ 各功能子系统的设计说明
|
||||
@@ -31,7 +31,7 @@ docs/
|
||||
```
|
||||
|
||||
> ⚠️ `docs/芯片手册/`(约 120 MB / 1754 张图)为**只读外部输入资料**,与代码演进无关;
|
||||
> 后续拆分独立仓库或降采样(登记簿条目「仓库体积膨胀观察」,已决策暂不处理)。
|
||||
> 后续拆分独立仓库或降采样(仓库膨胀观察项,已决策暂不处理)。
|
||||
|
||||
---
|
||||
|
||||
@@ -54,7 +54,7 @@ docs/
|
||||
- **应用/驱动开发** → §4 架构设计 → §5 子系统设计 → §7 问题记录(**改驱动前必读对应 Trap Records**)
|
||||
- **测试/验证** → §6 测试说明 → §9.2 环境与部署
|
||||
- **UI 开发** → §8 UI 设计 → §6 测试说明(串口助手、UI 自动化测试流程)
|
||||
- **接手/评审** → §9.1 评审报告 → §9.3 任务规划(统一待办登记簿,见 `任务规划/README.md`)
|
||||
- **接手/评审** → §9.1 评审报告 → §9.3 任务规划(全项目顺序,见 `任务规划/README.md`)
|
||||
|
||||
---
|
||||
|
||||
@@ -207,7 +207,7 @@ docs/
|
||||
| [`RAM使用分析与优化方案.md`](内存管理/RAM使用分析与优化方案.md) | **内存主文档**:占用分析、优化方案、定栈规则 |
|
||||
| [`内存内容分配策略.md`](内存管理/内存内容分配策略.md) | 各内存区(SRAM/CCM)的分配策略 |
|
||||
| [`存储栈RAM优化调研.md`](内存管理/存储栈RAM优化调研.md) | 存储栈 RAM 优化调研与结论 |
|
||||
| [`RAM预算台账.md`](内存管理/RAM预算台账.md) | **预算台账**:子系统配额、CCM 分配、趋势基线与 92% 门禁(登记簿条目「缩堆迁 CCM 后半(暂缓)」,2026-10-12) |
|
||||
| [`RAM预算台账.md`](内存管理/RAM预算台账.md) | **预算台账**:子系统配额、CCM 分配、趋势基线与 92% 门禁(内存治理三件套,2026-10-12) |
|
||||
| `data/` | `ram_report_*.md` / `stack_report_*.md` 快照数据(由 `scripts/` 生成) |
|
||||
|
||||
### 7.3 问题记录(**改驱动前必读**)
|
||||
@@ -247,7 +247,7 @@ docs/
|
||||
|
||||
> 体系层评审报告《项目审查与优化建议报告》(原在 `问题记录/`)已于 **2026-10-25 删除**——
|
||||
> 大部分内容已闭环,留着的只有历史快照与重复清单。结论的去处:
|
||||
> 未闭环项 → [`任务规划/登记簿.md`](任务规划/登记簿.md);内存与 Flash 结论(含整簇暂缓的**重开条件**)
|
||||
> 未闭环的设计约束 → 各模块文档「已知限制/重开条件」节;内存与 Flash 结论(含整簇暂缓的**重开条件**)
|
||||
> → [`内存管理/RAM使用分析与优化方案.md`](内存管理/RAM使用分析与优化方案.md) §2.5 / §2.6.4 / §4;
|
||||
> UI 侧硬约束 → [`UI设计/UI_设计架构.md`](UI设计/UI_设计架构.md) §1.4;
|
||||
> 六个自有编号族(属主文档已删的那批)→ `scripts/archive/id_gate/编号治理历史.md` §4.5(只能删号留事实,别再引用那些号)。
|
||||
@@ -263,7 +263,7 @@ docs/
|
||||
|
||||
| 位置 | 内容 |
|
||||
|---|---|
|
||||
| [`任务规划/`](任务规划/README.md) | **统一待办入口(3 个文件)**:`README.md` = 现在做什么与全项目顺序;`登记簿.md` = 全部待办、外部窗口与长期观察(UI 补齐已于 2026-11-06 整体销项,页面口径归 `docs/UI设计/内容页架构.md` §7.1 与 `菜单页面设计.md` §3.9,原执行清单文件已删除;采集数据可信度的设计口径与台阶图归 `docs/硬件平台/ADC通道映射说明.md` §9 与 `docs/算法/采集与算法层设计说明.md` §13);`暂缓-RS485.md` = 暂缓专项(`测试与架构专项.md` 已删除 2026-10-28,未闭环约束并入 `暂缓-RS485.md`;`屏板链路.md` 已完成,转为 `子系统设计/屏板链路设计说明.md` 后删除)。完成即删,重复内容只保留一个归属 |
|
||||
| [`任务规划/`](任务规划/README.md) | **两个文件**:`README.md` = 全项目推进顺序(唯一权威);`登记簿.md` = V0.1 硬件缺陷 → V0.2 改版要求。其余待办跟着所属模块走(各文档「已知限制 / 重开条件」节):采集数据可信度 → `docs/算法/采集与算法层设计说明.md` §13、台阶图 → `docs/硬件平台/ADC通道映射说明.md` §9、RS-485 → `docs/产品需求/产品需求设计文档.md` §5.10 |
|
||||
| `硬件平台/` | 网表详细分析报告与语义图(V0.0 / V0.1);**[`ADC通道映射说明.md`](硬件平台/ADC通道映射说明.md)——V0.1 十七路 ADC 语义/网名/通道号权威映射表(固件取数、UI 显示、自检注入以此为准),含 §7 链路四段口径、§8 注入实测记录与 §9 数据可信五级台阶/波次退出判据** |
|
||||
| `芯片手册/` | 外部芯片数据手册转录(CH395F / GD5F2GQ5UE / SD2506 / TPAFE5160 / RTL8305NBI 等) |
|
||||
| `images/` | 文档技术配图(`.svg` 产物,由 `tools/arch_diagram/`、`tools/refgraph/` 生成) |
|
||||
@@ -298,4 +298,4 @@ docs/
|
||||
| ~~缺一致性门禁~~ | — | ✅ 已落地(2026-09-25/26,文档门禁三档齐):`scripts/check_doc_links.py`(存在性)+ `scripts/gen_task_table.py`(数值)+ `scripts/check_mem_numbers.py`(体积),接入 pre-commit `doc-links` / `task-table` / `mem-numbers` 钩子 |
|
||||
| ~~`docs/文档规范.md` 未创建~~ | — | ✅ 已创建(2026-09-25):[`文档规范.md`](文档规范.md) |
|
||||
|
||||
> 未闭环的文档类问题**只剩仓库膨胀**(登记簿条目「仓库体积膨胀观察」,已决策暂不处理)。
|
||||
> 未闭环的文档类问题**只剩仓库膨胀**(仓库膨胀观察项,已决策暂不处理)。
|
||||
|
||||
Reference in New Issue
Block a user