docs(产品需求): 需求基线拆薄为三档(大厂标准),doc-links 增别名解析
产品需求设计文档.md v1.9 → v2.0(2691 → 1816 行): - 新增 §2 背景·目标用户·典型场景·成功指标,§3.2 产品级非目标表, §4 P0/P1/P2 需求总览(19 行);§9 收窄为缺口清单与推进顺序。 - 拆出 docs/产品需求/参考产品复刻明细.md(803 行):复刻基线 + 定值/遥测/开入开出/事件/元件/录波/记录/规约逐项差额与完成判据。 - 拆出 docs/架构设计/系统架构与硬件规格.md(215 行):运行时架构 (就绪位表/机制表/启动时序)+ V0.1 硬件规格;与项目架构总览 定分工——位表/机制表/时序图/引脚表以新档为准。 引用同步:AGENTS.md 引脚表指针改指系统架构与硬件规格 §2.2; docs/README.md 目录树与索引四处重写;故障录波三处「录波采样率」 行指针改指复刻明细 §7;PRD §11 补两新档指针。 门禁工具:check_doc_links.py 裸名解析增别名后缀匹配(「见需求档 §5.16」形态),§ 链遇紧邻已登记别名换目标;section_aliases.json 登记 需求档 / 架构硬件档 / 复刻明细(档) / 产品需求设计文档 / 系统架构与硬件规格。 终验:doc --all rc=0(3038 处 / 可判定 80%);mermaid --all 64 围栏 0 命中;改动文件字节卫生全过;新旧逐行差集审计无丢行。
This commit is contained in:
+6
-4
@@ -12,8 +12,8 @@
|
||||
docs/
|
||||
├── README.md 本索引(阅读顺序 + 全量清单)
|
||||
├── 任务规划/ 统一待办(README 单一入口 + 6 个职责文件)
|
||||
├── 产品需求/ 产品需求设计文档(面向产品的需求基线)
|
||||
├── 架构设计/ 全局架构与设计方法论
|
||||
├── 产品需求/ 产品需求设计文档(需求基线)+ 参考产品复刻明细(逐项差额)
|
||||
├── 架构设计/ 全局架构与设计方法论(含 系统架构与硬件规格:位表/引脚权威)
|
||||
├── 子系统设计/ 各功能子系统的设计说明
|
||||
├── 算法/ 傅氏算法与继电保护算法专题
|
||||
├── 网络/ BSD Socket API 使用与内部实现
|
||||
@@ -41,7 +41,7 @@ docs/
|
||||
|
||||
| 顺序 | 文档 | 读它能得到什么 |
|
||||
|:---:|---|---|
|
||||
| 1 | [`产品需求设计文档.md`](产品需求/产品需求设计文档.md) | 产品定位、功能/非功能需求、接口规范、UI 规格、路线图与验收判据 |
|
||||
| 1 | [`产品需求设计文档.md`](产品需求/产品需求设计文档.md) | 产品定位·用户·场景、优先级总览、功能/非功能需求、接口规范、UI 规格、路线图与验收判据(架构与硬件规格见 [`系统架构与硬件规格.md`](架构设计/系统架构与硬件规格.md),复刻逐项差额见 [`参考产品复刻明细.md`](产品需求/参考产品复刻明细.md)) |
|
||||
| 2 | [`项目架构总览.md`](架构设计/项目架构总览.md) | 六层分层、启动时序、存储/网络/UI 三栈、目录组织 |
|
||||
| 3 | [`项目启动顺序管理.md`](架构设计/项目启动顺序管理.md) | Event Flags 就绪屏障(取代魔法延时)的任务启动模型 |
|
||||
| 4 | [`项目部署环境要求.md`](环境与部署/项目部署环境要求.md) | 开发机/目标板/现场部署的完整环境核对清单 |
|
||||
@@ -62,7 +62,8 @@ docs/
|
||||
|
||||
| 文档 | 内容 |
|
||||
|---|---|
|
||||
| [`产品需求设计文档.md`](产品需求/产品需求设计文档.md) | **面向产品的需求基线**:产品定位与形态、六层架构与任务模型、V0.1 硬件规格、功能需求(网络/存储/时间/配置/日志/UI/看门狗/LED + 待实现的 ADC/RS-485)、接口规范(RemoDispBus / 对时 / FTP / 配置 / 串口)、非功能需求(可靠性/性能/内存/门禁/双端)、UI 规格、待实现项与路线图、验收判据 |
|
||||
| [`产品需求设计文档.md`](产品需求/产品需求设计文档.md) | **面向产品的需求基线**:背景·目标用户·典型场景、范围与产品级非目标、需求总览(P0/P1/P2)、功能需求(网络/存储/时间/配置/日志/UI/看门狗/LED/ADC/RS-485/测频/保护/定值/SOE/104/屏板链路)、接口规范(RemoDispBus / 对时 / FTP / 配置 / 串口)、非功能需求(可靠性/性能/内存/门禁/双端)、UI 规格、缺口清单与推进顺序、验收判据 |
|
||||
| [`参考产品复刻明细.md`](产品需求/参考产品复刻明细.md) | **1:1 复刻的逐项差额权威**:参考源码能力清单(复刻基线)、104 地址空间、定值 249 项、遥测/开入开出/动作事件/元件/录波/记录/规约逐项明细、复刻完成判据、屏板链路复刻任务规划 |
|
||||
|
||||
---
|
||||
|
||||
@@ -71,6 +72,7 @@ docs/
|
||||
| 文档 | 内容 |
|
||||
|---|---|
|
||||
| [`项目架构总览.md`](架构设计/项目架构总览.md) | 系统全景:六层分层、启动时序、存储·网络·UI 栈、目录组织 |
|
||||
| [`系统架构与硬件规格.md`](架构设计/系统架构与硬件规格.md) | 就绪位表 / 线程通信机制表 / 启动时序图 / V0.1 引脚表与硬件未确认项(H1~H3)——**位表、机制表、时序图、引脚表以本档为准**(自产品需求档拆出) |
|
||||
| [`STM32F4-Base存储架构说明.md`](架构设计/STM32F4-Base存储架构说明.md) | GD5F2GQ5UE SPI NAND 之上的三层存储软件栈(FTL / dhara / FatFs) |
|
||||
| [`项目启动顺序管理.md`](架构设计/项目启动顺序管理.md) | CMSIS-RTOS v2 Event Flags 就绪屏障(`SYS_EVT_NET_READY` 等) |
|
||||
| [`图形绘制流程.md`](架构设计/图形绘制流程.md) | 文档配图规范:SVG 生成器 / Mermaid 选型与检查清单 |
|
||||
|
||||
Reference in New Issue
Block a user