wandering1
88601422c3
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 零新增问题。
5.7 KiB
5.7 KiB
doc-links — 文档引用一致性（路径存在性 + 章节号存在性 + 文件命名）
一句话：它管**"你引用的东西还在不在"——文件路径、
§小节号、文件命名合法。 它不管**你引用的那节内容还是不是你要讲的事（见 §6）。规范 =docs/文档规范.md。
- 配置：
entry: python scripts/check_doc_links.py --sections-strict，pass_filenames: true，files: \.md$（只跑改动的.md，但脚本内部对全库做一次--all复核更常见）。
1. 它在查什么
| 类 | 写法 | 解析基准 |
|---|---|---|
| A | Markdown 链接 [文本](相对路径) |
相对当前文档所在目录 |
| B | 反引号路径引用 `docs/xxx/yyy.md` |
相对仓库根（本仓约定：文档互引一律用仓库根相对路径） |
| C | 目录名 / 文件名规范 | 不得含空格与路径敏感字符 |
| D | 章节引用 `路径.md` §N.M |
目标文档里必须真有这个编号的标题 |
D 类刻意只校验紧邻写法：文档名与 § 之间只允许空白、反引号、括号。实测这样能把误报压到 0。
钩子带 --sections-strict，所以"紧邻/裸名/前缀/别名"几种不合规写法都会拦提交。
2. 为什么要它
- 本仓文档互引极密（实跑：2594 处章节引用），一次改名/删小节历史上要扫 10~30 个文件， 手工扫既慢又漏。
- 真实案例（本次写文档时发生，且这段解释本身又触发了一次同样的报错）：我在正文里只写了 本文档自引用——恰好本文档没有那个编号的小节，于是提交前被拦。这类"看着是人话、机器判成悬空" 的写法，靠这份门禁一条命令就能挑出来。
- 另一类真实价值：把某小节内容搬去别的文档后，旧引用若还指向原文档的同号小节，只要那个 号还在，它是合法的但错的——本门禁不报（见 §6 第 3 条），但号被删掉的情形会报， 而"搬家时顺手删旧号"是本仓的常规做法，所以多数迁移错误能被抓到。
3. 触发面
- 只跑
*.md；第三方目录由exclude控制，脚本内再兜一层；docs/芯片手册/属外部资料， 链接形态与文件名都不受控 → 整体豁免。 - 每次全库复核会打印统计。实跑：149 篇文档、章节引用 2594 处、机器可判定 1504 处（58%）； 跳过分类：昵称式 25 / 非文档锚点 13 / 变更记录 655 / 外部手册 341 / 省略文档名的跨文档引用 2 / 目标无编号体系 54 / 无法判定 0。
4. 报错怎么读
[示例] docs\代码规范\pre-commit使用说明.md:528 [章节引用（自引用）] §4.3（… 无此编号标题）
修法：确认它到底指哪篇 → 写成「`路径.md` §N.M」，或改指本文档现有编号。
- 单独跑：
& '.venv\Scripts\python.exe' scripts/check_doc_links.py --all --sections-strict； 想看"哪些引用判不了目标、建议怎么改写"：--section-todo。 - 合法的"故意引用不存在文件"的写法：行首/行内加
[计划]前缀（约定产物尚未创建）、 加[示例]标记（引用报错样例、日志片段），或在该行写"未创建 / 尚未创建 / 已删除 / 待排期"等状态词。
5. 好处
- 改名与挪目录有安全网（配合
scripts/rename_ref.py：git mv+ 自动改写全库引用 + 落盘后 自动跑本脚本复核），所以"改名"不再是靠人肉 grep 的危险动作。 - 把"引用要写全路径 + 紧邻编号"这条写作约定变成机器判定，读者永远能点开你指的地方。
6. 限制与盲区
- 只判存在性，不判语义。它只知道目标文档里那个节号还在，不知道那一节还在讲你要讲的事。 内容搬家而号还在 → 全绿但是错的。这是本门禁最大的盲区。
- 58% 的章节引用机器判不了（见 §3 的跳过分类）。其中"变更记录 655"是设计选择：历史行 不回改，所以不校验——代价是变更记录里的引用可以烂掉。
- 只校验紧邻写法：昵称式（文档简称 + 空格 + 节号）不校验。写法不紧邻 = 放过，所以规则是 "宁可啰嗦也要写全"。
- 表格里裸写的小节号、或"设计文档 + 编号"这种不写文件名的写法，会被当成本文档自引用 静默放过（本文恰好有同号小节就通过）。搬移内容时这是真踩过的坑。
- 豁免清单本身可被滥用：加个
[示例]就安静了。只有引用报错样例/日志片段才该用它。 - 只管
.md：代码注释里的文档引用不在范围内（那边靠人工与bsp-err之类的文档检查间接覆盖）。
补录（豁免与排除清单，迁移自原手册）：
- 排除目录：
.opencode/node_modules/、Lib/lvgl/、MDK-ARM/RTE/、docs/芯片手册/；simulator/已于 2026-10-11 从排除列表移除（其下三个 README 是本项目文档）。 - 状态词豁免的判定距离是引用附近 ±40 字符（未创建 / 尚未创建 / 已删除 / 待排期）。
- 规范依据 →
docs/文档规范.md§3（链接规范）与 §4（门禁）。 - 全库自检：
python scripts/check_doc_links.py --all（不带--sections-strict时只查路径与命名）。
7. 豁免与基线
- 没有"基线"概念：硬拦截，新写的引用必须合法。
- 有别名表
scripts/section_aliases.json：昵称 → 文档的映射，歧义就登记进去或把话写清楚。
8. 改这个门禁本身
- 放宽匹配（例如允许裸名引用）前先想清楚：误报压到 0 是靠"只认紧邻写法"换来的。
- 新增一类豁免，必须同时新增一类误报；把豁免写在
docs/文档规范.md与本节里，别只写进代码。