新增产品需求设计文档：完整产品需求基线

基于项目全量内容编写 docs/产品需求/产品需求设计文档.md，作为面向产品的需求基线，覆盖： - 产品概述：定位、形态与部署、设计目标与原则、产品范围 - 系统架构：六层分层、六任务模型、就绪屏障、启动时序、线程间通信 - 硬件规格：主控/内存、V0.1 外设引脚、存储器件、版本差异、平台约束 - 功能需求：网络/存储/时间/配置/日志/UI/看门狗/LED（已实现）+ ADC/RS-485（待实现） - 接口规范：端口、RemoDispBus、对时、FTP、配置格式、串口、对外 API - 非功能需求：可靠性、性能指标、内存预算、测试门禁、双端、权限 - UI 规格：屏幕/菜单树 42 节点/内容页/密码/字体 - 待实现项与路线图（阶段 B/C/D）、验收判据（构建/自检/现场/台架）同步在 docs/README.md 新增 §3 产品需求、§2 阅读顺序置顶、§1 目录树登记产品需求/，后续章节号顺延。
2026-10-06 02:48:54 +08:00
parent ad0fd53389
commit 9734c2526a
2 changed files with 931 additions and 30 deletions
@@ -12,6 +12,7 @@
 docs/
 ├── README.md                 本索引（阅读顺序 + 全量清单）
 ├── 待处理内容.md             统一待办登记簿（高频入口，保留在顶层）
+├── 产品需求/                 产品需求设计文档（面向产品的需求基线）
 ├── 架构设计/                 全局架构与设计方法论
 ├── 子系统设计/               各功能子系统的设计说明
 ├── 网络/                     BSD Socket API 使用与内部实现
@@ -38,23 +39,32 @@ docs/

 | 顺序 | 文档 | 读它能得到什么 |
 |:---:|---|---|
-| 1 | [`项目架构总览.md`](架构设计/项目架构总览.md) | 六层分层、启动时序、存储/网络/UI 三栈、目录组织 |
-| 2 | [`项目启动顺序管理.md`](架构设计/项目启动顺序管理.md) | Event Flags 就绪屏障（取代魔法延时）的任务启动模型 |
-| 3 | [`项目部署环境要求.md`](环境与部署/项目部署环境要求.md) | 开发机/目标板/现场部署的完整环境核对清单 |
-| 4 | [`项目部署环境要求.md`](环境与部署/项目部署环境要求.md) → 构建 | 跑通 `@build` / `@test`（见根 `AGENTS.md`） |
-| 5 | [`测试开发标准流程.md`](测试说明/测试开发标准流程.md) | 测试分层 L0~L3 与门禁决策表 |
-| 6 | [`嵌入式C语言代码规范_V1.0.md`](代码规范/嵌入式C语言代码规范_V1.0.md) | 命名/格式/注释规范（提交门禁强制） |
-| 7 | [`项目架构总览.md`](架构设计/项目架构总览.md) → 按需 | 进入具体子系统设计文档 |
+| 1 | [`产品需求设计文档.md`](产品需求/产品需求设计文档.md) | 产品定位、功能/非功能需求、接口规范、UI 规格、路线图与验收判据 |
+| 2 | [`项目架构总览.md`](架构设计/项目架构总览.md) | 六层分层、启动时序、存储/网络/UI 三栈、目录组织 |
+| 3 | [`项目启动顺序管理.md`](架构设计/项目启动顺序管理.md) | Event Flags 就绪屏障（取代魔法延时）的任务启动模型 |
+| 4 | [`项目部署环境要求.md`](环境与部署/项目部署环境要求.md) | 开发机/目标板/现场部署的完整环境核对清单 |
+| 5 | [`项目部署环境要求.md`](环境与部署/项目部署环境要求.md) → 构建 | 跑通 `@build` / `@test`（见根 `AGENTS.md`） |
+| 6 | [`测试开发标准流程.md`](测试说明/测试开发标准流程.md) | 测试分层 L0~L3 与门禁决策表 |
+| 7 | [`嵌入式C语言代码规范_V1.0.md`](代码规范/嵌入式C语言代码规范_V1.0.md) | 命名/格式/注释规范（提交门禁强制） |
+| 8 | [`项目架构总览.md`](架构设计/项目架构总览.md) → 按需 | 进入具体子系统设计文档 |

 **按角色**：
- **应用/驱动开发** → §3 架构设计 → §4 子系统设计 → §6 问题记录（**改驱动前必读对应 Trap Records**）
- **测试/验证** → §5 测试说明 → §2 环境与部署
- **UI 开发** → §7 UI 设计 → §5 测试说明（串口助手、UI 自动化测试流程）
- **接手/评审** → §8.1 评审报告 → §8.3 待处理内容（统一待办登记簿）
+- **应用/驱动开发** → §4 架构设计 → §5 子系统设计 → §7 问题记录（**改驱动前必读对应 Trap Records**）
+- **测试/验证** → §6 测试说明 → §9.2 环境与部署
+- **UI 开发** → §8 UI 设计 → §6 测试说明（串口助手、UI 自动化测试流程）
+- **接手/评审** → §9.1 评审报告 → §9.3 待处理内容（统一待办登记簿）

 ---

-## 3. 架构设计
+## 3. 产品需求
+
+| 文档 | 内容 |
+|---|---|
+| [`产品需求设计文档.md`](产品需求/产品需求设计文档.md) | **面向产品的需求基线**：产品定位与形态、六层架构与任务模型、V0.1 硬件规格、功能需求（网络/存储/时间/配置/日志/UI/看门狗/LED + 待实现的 ADC/RS-485）、接口规范（RemoDispBus / 对时 / FTP / 配置 / 串口）、非功能需求（可靠性/性能/内存/门禁/双端）、UI 规格、待实现项与路线图、验收判据 |
+
+---
+
+## 4. 架构设计

 | 文档 | 内容 |
 |---|---|
@@ -66,7 +76,7 @@ docs/

 ---

-## 4. 子系统设计
+## 5. 子系统设计

 | 文档 | 内容 |
 |---|---|
@@ -81,7 +91,7 @@ docs/
 | [`网络/Net层阻塞模型架构设计.md`](网络/Net层阻塞模型架构设计.md) | **等待模型**：pending 请求架构、五路完成语义、设计边界与性能特征 |
 ---

-## 5. 测试说明
+## 6. 测试说明

 **总流程与规范**

@@ -125,9 +135,9 @@ docs/

 ---

-## 6. 代码规范 · 文档规范 · 内存管理 · 问题记录
+## 7. 代码规范 · 文档规范 · 内存管理 · 问题记录

-### 6.1 代码规范（提交门禁相关）
+### 7.1 代码规范（提交门禁相关）

 | 文档 | 内容 |
 |---|---|
@@ -135,13 +145,13 @@ docs/
 | [`pre-commit使用说明.md`](代码规范/pre-commit使用说明.md) | 提交门禁配置、检查范围与排除项 |
 | [`cppcheck使用说明.md`](代码规范/cppcheck使用说明.md) | cppcheck 配置与告警处置 |

-### 6.1b 文档规范（写/改文档前必读）
+### 7.1b 文档规范（写/改文档前必读）

 | 文档 | 内容 |
 |---|---|
 | [`文档规范.md`](文档规范.md) | **文档体系强制约定**：目录/命名（无空格）、编码换行、链接形态（互链用根相对、图片用目录相对）、`[计划]` 标记、门禁三档、结构要素与常见错误速查 |

-### 6.2 内存管理（**新增任务/缓冲/栈前必读**）
+### 7.2 内存管理（**新增任务/缓冲/栈前必读**）

 | 文档 | 内容 |
 |---|---|
@@ -150,7 +160,7 @@ docs/
 | [`存储栈RAM优化调研.md`](内存管理/存储栈RAM优化调研.md) | 存储栈 RAM 优化调研与结论 |
 | `data/` | `ram_report_*.md` / `stack_report_*.md` 快照数据（由 `scripts/` 生成） |

-### 6.3 问题记录（**改驱动前必读**）
+### 7.3 问题记录（**改驱动前必读**）

 | 文档 | 内容 |
 |---|---|
@@ -161,7 +171,7 @@ docs/

 ---

-## 7. UI 设计
+## 8. UI 设计

 | 文档 | 内容 |
 |---|---|
@@ -177,21 +187,21 @@ docs/

 ---

-## 8. 评审报告 · 环境与部署 · 外部资料
+## 9. 评审报告 · 环境与部署 · 外部资料

-### 8.1 评审报告
+### 9.1 评审报告

 | 文档 | 内容 |
 |---|---|
-| [`问题记录/项目审查与优化建议报告.md`](问题记录/项目审查与优化建议报告.md) | 项目全景审查：文档/代码/架构/可靠性问题清单（D-1~D-7、N-xx、Px-xx）——**体系层评审报告，非待办池**（待办见 §8.3 `待处理内容.md`） |
+| [`问题记录/项目审查与优化建议报告.md`](问题记录/项目审查与优化建议报告.md) | 项目全景审查：文档/代码/架构/可靠性问题清单（D-1~D-7、N-xx、Px-xx）——**体系层评审报告，非待办池**（待办见 §9.3 `待处理内容.md`） |

-### 8.2 环境与部署
+### 9.2 环境与部署

 | 文档 | 内容 |
 |---|---|
 | [`项目部署环境要求.md`](环境与部署/项目部署环境要求.md) | 开发机软件环境、目标板资源预算、现场部署与验收步骤 |

-### 8.3 台账与外部资料
+### 9.3 台账与外部资料

 | 位置 | 内容 |
 |---|---|
@@ -202,7 +212,7 @@ docs/

 ---

-## 9. 新增文档约定
+## 10. 新增文档约定

 1. **目录归属**：按上表选目录；新子领域先建**无空格**目录名（如 `xxx设计/`），并在此索引登记。
 2. **命名**：主题词 + 类型后缀（`xxx设计说明.md` / `xxx_Test_Guide.md` / `xxx_Trap_Records.md`）。
@@ -216,7 +226,7 @@ docs/

 ---

-## 10. 已知文档问题（待清理）
+## 11. 已知文档问题（待清理）

 > 来源：《项目审查与优化建议报告》D-3/D-7。
 > **D-3 / D-6 / D-7 已处理完毕**（2026-09-25）：全库链接存在性检查通过（66 文档 0 失效）、任务表与
@@ -234,13 +244,14 @@ docs/

 ---

-## 11. 变更记录
+## 12. 变更记录

 | 日期 | 变更 | 说明 |
 |---|---|---|
+| 2026-10-05 | 新增产品需求文档 | 新建 `docs/产品需求/产品需求设计文档.md`（面向产品的需求基线）；本索引新增 §3 产品需求、§2 推荐阅读顺序置顶、§1 目录树补 `产品需求/`；后续章节号顺延（架构设计 §4 … 变更记录 §12） |
 | 2026-09-25 | 目录重组 + 索引建立 | 顶层 16 篇散落 md 归入 5 个新目录（`架构设计/` `子系统设计/` `网络/` `审查记录/` `环境与部署/`）；全仓库 90 处引用同步；新建本索引（D-5） |
-| 2026-09-25 | D-6 目录去空格 | `docs/UI 设计/` → `docs/UI设计/`；全仓库 67 处引用同步（含 URL 编码形态 `UI%20设计`）；命名约定写入 §9 |
+| 2026-09-25 | D-6 目录去空格 | `docs/UI 设计/` → `docs/UI设计/`；全仓库 67 处引用同步（含 URL 编码形态 `UI%20设计`）；命名约定写入 §10 |
 | 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-09-25 | 新建 `文档规范.md` | 正式确立文档体系规范（目录命名/编码换行/链接形态/门禁/结构/写作约定）；补入本索引 §7.1b |
 | 2026-10-04 | 待办文档合并 + 报告归档 | 4 份待办文档（`待处理内容.md` / `项目审计改进清单.md` / `下一步任务规划.md` / `测试与架构改进建议.md`）合并为**统一待办登记簿** `待处理内容.md`；`项目审查与优化建议报告.md` 移入 `问题记录/`，删除 `审查记录/` 目录；全仓库引用同步 |