docs: 项目审查报告移入 问题记录/，删除空的 审查记录/ 目录
让评审报告与 待处理内容.md 的分工更直观： - git mv 项目审查与优化建议报告.md → docs/问题记录/（与 Trap 台账、 错误码传播审计同处"专项审计"目录）；rmdir 空的 docs/审查记录/。 - docs/README.md：§8 标题改为「评审报告 · 环境与部署 · 外部资料」， §8.1 改为「评审报告」，目录树删 审查记录/、补 问题记录/ 说明， 按角色导航改为 §8.1/§8.3，补 2026-10-04 变更记录。 - 根 README.md 目录树同步。 - docs/文档规范.md §1.1 现有目录列表、§6 归属表同步。 - 看门狗设计说明.md / 待处理内容.md 的路径引用重定向。 pre-commit 17/17 Passed。
This commit is contained in:
+9
-9
@@ -1,6 +1,6 @@
|
||||
# docs/ 文档索引
|
||||
|
||||
> **定位**：本目录是 STM32F4-Base 项目的**工程文档库**——架构设计、子系统设计、测试规范、审查记录与外部资料。
|
||||
> **定位**：本目录是 STM32F4-Base 项目的**工程文档库**——架构设计、子系统设计、测试规范、问题记录（含专项审计与评审报告）与外部资料。
|
||||
> **权威入口**：日常开发以仓库根 `AGENTS.md`（面向 AI/开发者）为第一入口；本文档提供**人类可读的全量索引与推荐阅读顺序**。
|
||||
> **约定**：目录名不含空格；新增文档必须登记到本索引（见文末「新增文档约定」）。
|
||||
|
||||
@@ -19,8 +19,7 @@ docs/
|
||||
├── 代码规范/ 编码规范与静态检查门禁
|
||||
├── 文档规范.md 本文档体系的规范（命名/链接/门禁/结构）
|
||||
├── 内存管理/ RAM 预算、分配策略与优化调研
|
||||
├── 问题记录/ 模块陷阱台账与专项审计
|
||||
├── 审查记录/ 项目审查报告与改进清单
|
||||
├── 问题记录/ 模块陷阱台账、专项审计与项目评审报告
|
||||
├── 环境与部署/ 环境搭建与部署核对清单
|
||||
├── UI设计/ UI 架构、页面设计、字体与模拟器
|
||||
├── 硬件平台/ 网表分析报告与语义图
|
||||
@@ -29,7 +28,7 @@ docs/
|
||||
```
|
||||
|
||||
> ⚠️ `docs/芯片手册/`（约 120 MB / 1754 张图）为**只读外部输入资料**，与代码演进无关；
|
||||
> 后续按《项目审查与优化建议报告》D-1 建议拆分独立仓库或降采样（见 `审查记录/项目审查与优化建议报告.md`）。
|
||||
> 后续按《项目审查与优化建议报告》D-1 建议拆分独立仓库或降采样（见 `问题记录/项目审查与优化建议报告.md`）。
|
||||
|
||||
---
|
||||
|
||||
@@ -51,7 +50,7 @@ docs/
|
||||
- **应用/驱动开发** → §3 架构设计 → §4 子系统设计 → §6 问题记录（**改驱动前必读对应 Trap Records**）
|
||||
- **测试/验证** → §5 测试说明 → §2 环境与部署
|
||||
- **UI 开发** → §7 UI 设计 → §5 测试说明（串口助手、UI 自动化测试流程）
|
||||
- **接手/评审** → §8 审查记录 → §5 待处理内容
|
||||
- **接手/评审** → §8.1 评审报告 → §8.3 待处理内容（统一待办登记簿）
|
||||
|
||||
---
|
||||
|
||||
@@ -178,13 +177,13 @@ docs/
|
||||
|
||||
---
|
||||
|
||||
## 8. 审查记录 · 环境与部署 · 外部资料
|
||||
## 8. 评审报告 · 环境与部署 · 外部资料
|
||||
|
||||
### 8.1 审查记录
|
||||
### 8.1 评审报告
|
||||
|
||||
| 文档 | 内容 |
|
||||
|---|---|
|
||||
| [`项目审查与优化建议报告.md`](审查记录/项目审查与优化建议报告.md) | 项目全景审查：文档/代码/架构/可靠性问题清单（D-1~D-7、N-xx、Px-xx） |
|
||||
| [`问题记录/项目审查与优化建议报告.md`](问题记录/项目审查与优化建议报告.md) | 项目全景审查：文档/代码/架构/可靠性问题清单（D-1~D-7、N-xx、Px-xx）——**体系层评审报告，非待办池**（待办见 §8.3 `待处理内容.md`） |
|
||||
|
||||
### 8.2 环境与部署
|
||||
|
||||
@@ -231,7 +230,7 @@ docs/
|
||||
| ~~缺一致性门禁~~ | — | ✅ 已落地（2026-09-25/26，D-7 三档齐）：`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) |
|
||||
|
||||
> 完整清单与建议见 [`审查记录/项目审查与优化建议报告.md`](审查记录/项目审查与优化建议报告.md) §3.3。
|
||||
> 完整清单与建议见 [`问题记录/项目审查与优化建议报告.md`](问题记录/项目审查与优化建议报告.md) §3.3。
|
||||
|
||||
---
|
||||
|
||||
@@ -244,3 +243,4 @@ docs/
|
||||
| 2026-09-25 | D-7 文档-代码一致性门禁 | 新建 `scripts/check_doc_links.py`（链接存在性，含行内代码豁免/就近状态词/`[计划]` 标记）、`scripts/gen_task_table.py`（任务表由 `Src/freertos.c` 生成/校验，锚点 `TASK_TABLE:BEGIN/END`）；接入 pre-commit `doc-links`/`task-table` 钩子；全库 66 文档 0 失效 |
|
||||
| 2026-09-26 | D-7 体积档落地 | 新建 `scripts/check_mem_numbers.py`（内存/Flash 数字以 `.map` 为事实源，锚点 `MEM_SNAPSHOT:BEGIN/END` + 陈旧散句数字扫描）；接入 pre-commit `mem-numbers` 钩子；上线即抓出 6 处真实失真（RW_IRAM1 82,048→87,040、ROM 249,432→262,660 等） |
|
||||
| 2026-09-25 | 新建 `文档规范.md` | 正式确立文档体系规范（目录命名/编码换行/链接形态/门禁/结构/写作约定）；补入本索引 §6.1b |
|
||||
| 2026-10-04 | 待办文档合并 + 报告归档 | 4 份待办文档（`待处理内容.md` / `项目审计改进清单.md` / `下一步任务规划.md` / `测试与架构改进建议.md`）合并为**统一待办登记簿** `待处理内容.md`；`项目审查与优化建议报告.md` 移入 `问题记录/`，删除 `审查记录/` 目录；全仓库引用同步 |
|
||||
|
||||
Reference in New Issue
Block a user