wandering1/STM32F4-Base
1
0
Fork 0
Code Issues 21 Pull Requests Actions Packages Projects 2 Releases Wiki Activity

docs(文档规范): 清空壳变更记录节，例外清单改成可复跑口径

Browse Source 
17 篇文档的变更记录（含修订记录、带编号与中文序号标题）节里只剩一句
「不再记流水账」的占位话，整节删掉，连带它前面的分隔线。
仍保留真台账的只有 5 篇（看门狗 / 配置文件设计 / RAM 预算台账 /
内容页架构 / 本地工具路径方案），外加 scripts/archive 归档区。

份数口径改成可复跑的普查：文档规范 §5.1 补自查命令，
stale-doc-count-sweep 的速查表与陷阱各加一条——只 grep 裸标题会漏
带编号与中文序号的两种写法，实测 5 篇只数得出 3 篇，差点据此把
全仓正确的份数改错。

门禁：逐篇与全量 check_doc_links 除 simulator/SDL2 联接假红外 0 问题；
skill-size rc=0；表格列数与字节体检相对 HEAD 零新增问题。
This commit is contained in:
Wanderingss
2026-10-29 21:21:59 +08:00
parent 1cf9f6f021
commit 88601422c3
21 changed files with 14 additions and 93 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/CI/README.md
-4
View File
@@ -76,7 +76,3 @@
- 本地等价脚本：[`../../scripts/ci_local.py`](../../scripts/ci_local.py)
- runner 机器的工具链环境要求：[`../环境与部署/项目部署环境要求.md`](../环境与部署/项目部署环境要求.md)
- `DTU_*` 工具路径变量机制：[`../环境与部署/本地工具路径环境变量方案.md`](../环境与部署/本地工具路径环境变量方案.md)
## 变更记录
> （本文件不再记流水账：改了什么是正文说了算，改动过程查 git log。）
docs/CI/远程CI完整指南.md
-6
View File
@@ -1350,9 +1350,3 @@ powershell -ExecutionPolicy Bypass -File scripts\ci_runner_bootstrap.ps1 -DryRun
> 更早基于 Windows 服务的 `deploy_runner.ps1` / `install_service.ps1` 已删除
> —— 那条路走不通（§3.0）。
---
## 变更记录
> （本文件不再记流水账：改了什么是正文说了算，改动过程查 git log。）
docs/README.md
-6
View File
@@ -278,9 +278,3 @@ docs/
| ~~`docs/文档规范.md` 未创建~~ | — | ✅ 已创建（2026-09-25）：[`文档规范.md`](文档规范.md) |
> 未闭环的文档类问题**只剩仓库膨胀**（登记簿条目「仓库体积膨胀观察」，已决策暂不处理）。
---
## 12. 变更记录
> （本文件不再记流水账：改了什么是正文说了算，改动过程查 git log。）
docs/UI设计/UI_自动化测试流程.md
-5
View File
@@ -200,8 +200,3 @@ cmake --build simulator/build --config Debug # 0) 构建模拟器（须 0 警
（两套走法迟早分叉，而分叉的那一边往往是真机）。导航器**默认只过查看密码**：判据需要写
路径权限时必须显式传 `modify=True`，**不因「能进去」就自动升格成可写**——只读判据偷偷拿到
修改权限，等于把判据的边界让给了实现。
---
## 变更记录
> （本文件不再记流水账：改了什么是正文说了算，改动过程查 git log。）
docs/UI设计/UI_设计架构.md
-4
View File
@@ -288,7 +288,3 @@ ENTER/→ 进子框：
- **残留暴露**（刻意不归本票）：单个往返自身仍无上界（osMessageQueuePut(osWaitForever)
+ xTaskNotifyWait(portMAX_DELAY)），netTask 若被单消息拖 >800ms，UI 位连击照成立——
那是「判据抓对了人」，处置在 net 侧，不在心跳侧。
## 六、变更记录（简表）
> （本文件不再记流水账：改了什么是正文说了算，改动过程查 git log。）
docs/子系统设计/控制台单写者日志设计说明.md
-6
View File
@@ -481,9 +481,3 @@ D4 否决理由对现状仍逐条成立（115200 发送率低、日志行稀疏
| `tx_timeout` 读口接线（STALL 证据行加字段） | §13-O2 | 涉 `App/util/task_watchdog.c` 与被解析证据行的台架判据，非本卡写域；维持 O2“后续项” |
| 未注册期裸发互斥 / `printf` 遗留开销 | §13-O1/O3 | 现状 = 纪律已落地，开机日志密度上升再议 |
| 日志静默观察项 | 登记簿曾登记（已销项） | 见 A.3：V5 复跑双零后销项（归 lead） |
---
## 修订记录
> （本文件不再记流水账：改了什么是正文说了算，改动过程查 git log。）
docs/文档规范.md
+5 -8
View File
@@ -264,7 +264,7 @@
**章节引用（D 类）另有的跳过**：昵称式引用（「内存方案 §2.1」）、非紧邻写法、变更记录小节内的历史指称、外部手册编号（RM0090 等）、目标文档本身不用数字编号标题。
> 「变更记录小节内的历史指称」这条跳过规则为何还留着：2026-10-28 起新文档不再设该节（见 §5.1），它现在只为**保留变更记录的存量 5 篇**与 `scripts/archive/` 下的归档文档服务——历史行里的编号是「当时那个编号」，既不回改也不校验。
> 「变更记录小节内的历史指称」这条跳过规则为何还留着：2026-10-28 起新文档不再设该节（见 §5.1），它现在只为**保留变更记录的 3 篇真台账**与 `scripts/archive/` 下的归档文档服务——历史行里的编号是「当时那个编号」，既不回改也不校验。
> ⚠️ 状态词按**就近**（±40 字符）判定，不是整行——否则文件名本身含「不存在」「删除」等字样时会误豁免同行的其它真实引用（2026-09-25 实测修正）。
@@ -318,7 +318,10 @@
| **一级标题** | 文档首行为 `# 标题`，标题即主题，不写"文档""说明"等冗余后缀 |
| **开篇引言** | 可选 `>` 引用块，写明**适用对象 / 阅读前提 / 相关文档** |
| **章节编号** | 多章节文档用 `## 1.` `### 1.1` 编号，便于交叉引用（`§3.2`） |
| **变更记录** | **2026-10-28 裁定：新文档不再设「变更记录」节**——文档只写现状、改了什么是正文说了算，改动过程查 `git log`。**例外**（整表保留、被别处当台账或唯一证据出处引用的 5 篇）：`docs/子系统设计/看门狗设计说明.md`、`docs/子系统设计/配置文件设计说明.md`、`docs/内存管理/RAM预算台账.md`、`docs/UI设计/内容页架构.md`、`docs/环境与部署/本地工具路径环境变量方案.md` |
| **变更记录** | **一律不设该节**（用户裁定 2026-10-28 起新文档、2026-10-29 起老文档也清完；标题变体 `修订记录` / 带编号的 `## 6. 变更记录` / `## 九、变更记录` 同规则）——文档只写现状、改了什么是正文说了算，改动过程查 `git log`。**例外只有 5 篇**（整表保留：表里是真台账、且被别处当唯一证据出处引用）：`docs/子系统设计/看门狗设计说明.md`、`docs/子系统设计/配置文件设计说明.md`、`docs/内存管理/RAM预算台账.md`、`docs/UI设计/内容页架构.md`、`docs/环境与部署/本地工具路径环境变量方案.md`；`scripts/archive/` 下的归档文档整片都是历史，不受本条约束 |
> 数"还剩几篇留着这节"的命令（**别只 grep 裸标题**——带编号的 `## 6. 变更记录`、中文序号的 `## 九、变更记录`、`## 修订记录` 三种写法都要算）：
> `grep -rn "^## " docs scripts` 再看命中的标题；2026-10-29 实测 **5 篇**真台账（上表那五篇）+ `scripts/archive/` 归档一篇。
### 5.2 新增文档检查清单
@@ -373,9 +376,3 @@
| 提交 diff 出现整文件行尾变化 | 脚本改写时强制了 LF/CRLF | 改写须按原换行符回写（见 §2） |
| 图片不显示 | 文档迁入子目录后未改 `../images/` | 补 `../`（见 §3.2） |
| 引用"计划中"文件被拦 | 没加 `[计划] ` 前缀 | 加前缀 |
---
## 变更记录
> （本文件不再记流水账：改了什么是正文说了算，改动过程查 git log。）
docs/测试说明/自动化测试流程.md
-4
View File
@@ -136,7 +136,3 @@
`--forbidden "FAIL;HardFault"`（`[FAIL]` 仍会拦截真实断言失败）；
例：GD5F 只读 `--required "=== GD5F2GQ5UE Tests: 16/16 PASSED"`，破坏性 `68/68`。
- **长时间采集**：daemon 全量持续写入 `state/serial.log`（20MB 上限自动截头保尾 10MB），直接读文件即可；或用 `log --grep <标记>` 过滤（2026-10-10 起先过滤后截尾，不必再配 `--tail 0`）。
## 变更记录
> （本文件不再记流水账：改了什么是正文说了算，改动过程查 git log。）
docs/测试说明/配置文件单元测试说明.md
-6
View File
@@ -277,9 +277,3 @@ if (s_encode(p_key, ..., v, sizeof(v)) >= 0) {
（现有板端套件只测了"文件缺失 → 重建"路径，是本缺陷长期漏网的直接原因）。
- 检查是否存在同类"返回长度却按 `== 0` 判成功"的调用点（本次已全库核对 `s_encode`
的 4 处调用点，除本缺陷外其余正确）。
---
## 6. 变更记录
> （本文件不再记流水账：改了什么是正文说了算，改动过程查 git log。）
docs/环境与部署/项目部署环境要求.md
-6
View File
@@ -650,9 +650,3 @@ $env:DTU_KEIL_UV4 = 'D:\NotExist\UV4.exe' # 仅当前会话，不动用户级
| 引用关系图（文件引用） | `docs/架构设计/引用关系图说明.md`（生成工具 `tools/refgraph`；渲染依赖 Graphviz，§2.8） |
| 各模块测试指南 | `docs/测试说明/CH395F_Test_Guide.md`、`GD5F2GQ5UE_Test_Guide.md`、`SD2506_Test_Guide.md`、`FTP_Test_Guide.md` |
| 已知硬件陷阱 | `docs/问题记录/CH395F_Trap_Records.md` 等 |
---
## 变更记录
> （本文件不再记流水账：改了什么是正文说了算，改动过程查 git log。）
docs/编号规范.md
-6
View File
@@ -225,9 +225,3 @@ scripts/archive/id_gate/check_ids.py --top 0 # 全库存量普查（
- 编号形态拿不准 → 本文 §1 三句自问 + §4.1 那张表；**没有任何机器会替你兜**。两道门禁的历史与退役理由 →
`docs/门禁说明/id-check.md`、`docs/门禁说明/id-check-new.md`。
- 想让机器帮你扫一批改动，或要恢复机器面 → §8.5。
---
## 变更记录
> （本文件不再记流水账：改了什么是正文说了算，改动过程查 git log。）
docs/网络/网络自愈架构设计.md
+2 -2
View File
@@ -20,7 +20,7 @@
| `TRAP-NET-nn` | **陷阱记录**条目 | 同上 |
| `N-nn` | `docs/任务规划/登记簿.md` 的**任务/发现编号**（⚠ 已销项的号不再可查，本文引用处即其最终事实描述） | 该登记簿 |
| `D1`~`D7` | 本文**决策记录** | §10 |
| `自愈收敛阶段 N` | 2026-10 的分阶段实施标签，**只存在于历史文档与归档**（2026-10-28 清理流水后全仓仅剩 5 篇保留的变更记录）（代码注释已全部改为平实语言）；勾选清单已归档（§12）——**勿用它叙述设计，也勿再写回注释** | §12 |
| `自愈收敛阶段 N` | 2026-10 的分阶段实施标签，**只存在于历史文档与归档**（2026-10-29 起全仓仅剩 5 篇保留的变更记录真台账）（代码注释已全部改为平实语言）；勾选清单已归档（§12）——**勿用它叙述设计，也勿再写回注释** | §12 |
| `TSL` / `TSC` / `TSD` | SPI 命令与数据之间的**时序间隔**要求 | `docs/芯片手册/CH395F.md` §7.4 |
| `n30` | 压测脚本 `n30_repro.py`（:21 背靠背 STOR 30 轮），自愈回归的**主判据** | `test/host/` |
| 沉降窗 / 隔离期 | 释放会话后、重建监听前的**最短等待**（GRACEFUL 100 ms / QUARANTINE 400 ms） | §4.3 |
@@ -868,5 +868,5 @@ accept 走 `handle_connect_event`），且 `NET_RECON_STABLE_DEATH` 两边共用
`git log --oneline -- docs/网络/N34-自愈审计/`；
- 监听生命周期（本文 §1.1~§1.4 / §4.9 / §9~§11 的来源，含 P0~P3 勾选清单与台架验收记录）：
`git log --oneline -- docs/子系统设计/网络Socket监听生命周期设计说明.md`；
- `自愈收敛阶段 N` 只出现在历史文档与归档里（变更记录节已清理，仅 5 篇保留）（代码注释已清理为平实语言）——
- `自愈收敛阶段 N` 只出现在历史文档与归档里（变更记录节已清理，全仓只剩 5 篇真台账）（代码注释已清理为平实语言）——
**勿再引入**，设计含义一律以本文 §2~§4 为准。
docs/门禁说明/bsp-err.md
-4
View File
@@ -140,7 +140,3 @@ BSP 约定：命中 38（在册 38 / 新增 0），基线共 38
- 加新的 must-use HAL 族：改 `HAL_STATUS_RE`，同时补一条正反例自测。
- 改标签名：脚本与基线一次改完（§6 第 9 条），随后 `--emit-baseline` 复核数量不变。
- 门禁自己的注释里不要写只有本次会话懂的代号；要引用规范就写`文件.md` + 紧邻编号。
## 9. 变更记录
> （本文件不再记流水账：改了什么是正文说了算，改动过程查 git log。）
docs/门禁说明/doc-links.md
-4
View File
@@ -85,7 +85,3 @@ D 类刻意只校验**紧邻写法**：文档名与 `§` 之间只允许空白
- 放宽匹配（例如允许裸名引用）前先想清楚：**误报压到 0 是靠"只认紧邻写法"换来的**。
- 新增一类豁免，必须同时新增一类误报；把豁免写在 `docs/文档规范.md` 与本节里，别只写进代码。
## 9. 变更记录
> （本文件不再记流水账：改了什么是正文说了算，改动过程查 git log。）
docs/门禁说明/font-charset.md
-4
View File
@@ -98,7 +98,3 @@ A 通过 + B 通过 ⟹ 字体覆盖"源码在用"与"刻意保留"的每一个
- 放宽"必需集"来源（比如不再扫某个目录）前先确认该目录的字最终确实会进生成链；
- 与 `ui-golden` 是互补关系：本门管"有没有字形"，golden 管"像素对不对"。
## 9. 变更记录
> （本文件不再记流水账：改了什么是正文说了算，改动过程查 git log。）
docs/门禁说明/id-check.md
-5
View File
@@ -238,8 +238,3 @@
3. 更省事的正解是**写注释与文档时一开始就别用裸形**：改用语义短语，或写全号 + 紧邻属主文档名。同日还有一
次反向教训：为「省余量」把在册族的号改成散文，那才是真把护栏当敌人（见 §7.7）。
4. 附带收益常比余量值钱：这次顺带消掉一个**同形两义**的撞号源（同一裸形既像自造状态号又撞已登记族）。
## 9. 变更记录
> （本文件不再记流水账：改了什么是正文说了算，改动过程查 git log。）
docs/门禁说明/layer-deps.md
-4
View File
@@ -94,7 +94,3 @@
- 往 `ALLOW` 加条目要写理由，并想清楚会不会变成"给上层开后门"；能进基线就别进 `ALLOW`。
- 还掉一条债就跑 `--prune` 并删掉那一行；基线只减不增，加行等于放弃约束。
## 9. 变更记录
> （本文件不再记流水账：改了什么是正文说了算，改动过程查 git log。）
docs/门禁说明/ui-golden.md
-4
View File
@@ -76,7 +76,3 @@
- 加新页面 / 新状态时，要同时扩参考图集合，否则新页面**完全没有回归**（不会报错，只是没覆盖）；
- 触发面 `files:` 每加一类能改像素的入口就补一行，漏一类 = 那一类改动静默不跑回归。
## 9. 变更记录
> （本文件不再记流水账：改了什么是正文说了算，改动过程查 git log。）