docs(wave): 触发源字母汉字化注记——手册补 src 速查表,人读文案改「保护触发(P)」式(#83) #97

Merged
wandering1 merged 1 commits from docs-trig-legend-83-6f432acbeab7 into master 2026-11-07 22:12:34 +08:00
Collaborator

This is by an automated agent, not a human.

为什么改(#83 评论 755 用户反馈)

工单与到场轮文档一直裸写「P 触发 / src=P / bench T 源」这类字母缩写、没在原地给释义,用户读不懂。字母本身是串口 wave: 心跳与回放页字段的 grep 契约(属主 docs/子系统设计/故障录波设计说明.md §9),不能改成汉字;于是把人读文案改成汉字在前,并在手册开头补一张速查表。

改了什么

  • 手册开头补「触发源字母速查」:M=手动录波 / P=保护启动触发 / T=定时自抓(bench)/ -=本次上电未触发,注明四字母为串口契约、不改汉字;
  • 手册 §1 第三幕行、§5 标题、决定一语句、§9 时间表与 mermaid 节点:「P 触发」→「保护触发对时刻(src=P)」式汉字在前写法;
  • docs/README.md 手册条目、docs/任务规划/README.md §2.0 独立行:「保护触发 / 定时自抓」加注;
  • 串口字段值 src=P / src=T 与 docs/测试说明/测试数据/ 下抓帧原件逐字不动(证据不改写)。

验证

  • scripts/check_doc_links.py --all 通过(3243 处引用、无法判定 0);
  • 三个改动文件 U+FFFD 计数 0、BOM 状态与 HEAD 一致;
  • 纯文档改动,不涉编译;CI 跑静态门禁与主机单测兜底。
This is by an automated agent, not a human. ## 为什么改(#83 评论 755 用户反馈) 工单与到场轮文档一直裸写「P 触发 / src=P / bench T 源」这类字母缩写、没在原地给释义,用户读不懂。字母本身是串口 `wave:` 心跳与回放页字段的 grep 契约(属主 `docs/子系统设计/故障录波设计说明.md` §9),不能改成汉字;于是把**人读文案改成汉字在前**,并在手册开头补一张速查表。 ## 改了什么 - 手册开头补「触发源字母速查」:**M=手动录波 / P=保护启动触发 / T=定时自抓(bench)/ `-`=本次上电未触发**,注明四字母为串口契约、不改汉字; - 手册 §1 第三幕行、§5 标题、决定一语句、§9 时间表与 mermaid 节点:「P 触发」→「保护触发对时刻(src=P)」式汉字在前写法; - `docs/README.md` 手册条目、`docs/任务规划/README.md` §2.0 独立行:「保护触发 / 定时自抓」加注; - 串口字段值 `src=P` / `src=T` 与 `docs/测试说明/测试数据/` 下抓帧原件**逐字不动**(证据不改写)。 ## 验证 - `scripts/check_doc_links.py --all` 通过(3243 处引用、无法判定 0); - 三个改动文件 U+FFFD 计数 0、BOM 状态与 HEAD 一致; - 纯文档改动,不涉编译;CI 跑静态门禁与主机单测兜底。
super_agent_bot added 1 commit 2026-11-07 22:09:57 +08:00
docs(wave): 触发源字母汉字化注记——手册补 src 速查表,人读文案改「保护触发(P)」式(#83)
CI / 静态门禁 (pre-commit) (push) Failing after 45s
CI / 主机侧单测 (MSVC) (push) Failing after 42s
82a84a4264
用户反馈「P 触发」这类字母看不懂(#83 评论 755)。

- 手册开头补「触发源字母速查」:M=手动录波 / P=保护启动触发 /
  T=定时自抓(bench)/ -=本次上电未触发;注明四字母是串口与台架
  脚本的 grep 契约、不改汉字,契约定义属主仍指设计说明 §9;
- 手册 §1/§5/§9、docs/README、任务规划 README §2.0 的人读文案把
  裸字母改成「保护触发对时刻(src=P)」式汉字在前的写法;
- 串口字段 src=P / src=T 与测试数据目录下的抓帧原件逐字保留。
super_agent_bot force-pushed docs-trig-legend-83-6f432acbeab7 from 0474cbd74a to 82a84a4264 2026-11-07 22:09:57 +08:00 Compare
wandering1 merged commit 01fde986ee into master 2026-11-07 22:12:34 +08:00
wandering1 deleted branch docs-trig-legend-83-6f432acbeab7 2026-11-07 22:12:36 +08:00
Sign in to join this conversation.
No Reviewers
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: wandering1/STM32F4-Base#97