wandering1
|
2053f6d913
|
docs(iec60870): 把 104 板端落地文档归入 docs/iec60870/板端落地
四篇讲「本项目怎么接 104」的文档原来散在子系统设计与网络两个目录,
和随库迁入的 36 篇协议库设计混在一起。现集中到 docs/iec60870/板端落地/:
- IEC104上行设计说明.md(原 docs/子系统设计/)
- IEC104_Net适配契约.md(原 docs/网络/)
- IEC104_MCU落地规划.md(原 docs/子系统设计/)
- IEC104_MCU最小可行性验证.md(原 docs/子系统设计/)
改动:
- 四篇 git mv 保留历史,全库引用经 rename_ref.py 逐篇改写(27 个文件
54 处引用行),旧路径残留扫描为 0。
- docs/README.md:§5.3 改为「IEC 60870-5-104 文档(40 篇)」,拆成
「板端落地 4 篇」与「协议库设计与接口 36 篇」两张表,说明两条轴的分工;
从 §5.1 功能子系统表里移除这三篇的重复条目。
- docs/iec60870/README.md:新增两条轴入口与板端落地表,原阅读顺序
改标注为「协议库部分」。
验证:
- check_doc_links.py --all --sections-strict:310 篇 0 问题。
- 三份索引 markdown 链接可达性逐个 exists() 校验,断链 0;索引表覆盖
36 篇协议库文档,与实际磁盘文件双向差集为空。
- 板端落地目录 4 篇 BOM / CR / U+FFFD 均为 0。
- 工作树 Keil 权威构建 0 errors 0 warnings(Code=365896 RO=48336
RW=2736 ZI=173104),此后预提交 21 Passed / 0 Failed。
|
2026-11-18 23:31:37 +08:00 |
|
wandering1
|
11f7c07b3d
|
docs(iec60870): 4 篇文档首行改一级标题,删两处变更记录节
4 篇 common/ 设计文档原以 <a id="..."></a> 空锚点开头,一级标题在第 2 或
第 3 行,不符合 docs/文档规范.md §5.1「文档首行为 # 标题」。已删掉文档级
锚点行,让一级标题回到首行;11 处指向这些锚点的跨文档链接同步去掉
#anchor 后缀(同文档本就只有一个一级主题,去掉后缀仍指向文件顶部)。
删除两处「变更记录」节(规范 §5.1:一律不设该节,改动过程查 git log):
- 104/IEC104_设计架构.md:删「## 八、变更记录」8 行表;原第九、第十节
前移为第八、第九节,其下 9.1~9.6 子节号同步重排,全文无 10.x 残留。
- 104/IEC104_Link_设计架构.md:删「### 9.2 变更记录」42 行表;「## 九、
设计决策与变更记录」改名「## 九、设计决策」,9.1 保留。
验证:check_doc_links.py --all --sections-strict RC=0(308 篇全过,问题 0);
mermaid 预检 10 文件 18 块新发 0;pre_commit 6 Passed / 0 Failed;
6 文件 BOM=False / CR=0 / U+FFFD=0。纯文档改动,未碰代码与构建。
|
2026-11-18 22:57:58 +08:00 |
|
wandering1
|
b7a23d9f85
|
docs(iec60870): 把 104 协议库文档从供应商快照迁入项目文档库
IEC60870-Slave/docs 下 36 篇(约 2.8 MB)整体迁到 docs/iec60870/,
git 历史随 rename 保留:104/ 24 篇、common/ 7 篇、examples/ 3 篇、
test/ 1 篇、顶层 README.md 导航 1 篇。
源码链接改指项目代码(用户裁定:IEC60870-Slave 将来要删,那里不是
项目源码):
- 187 条链接按文件名唯一匹配改成 App/iec60870/... 的相对路径
- 364 条在项目里没有同名文件,退化成行内代码,不再当链接
- md 之间的相对链接 1289 条原样保留(目录结构未变)
7 篇讲本项目未实现模块的文档(文件服务、软件升级、冻结电能、故障
录波、历史记录、运行日志、持久化升级)在原一级标题后加统一标注,
说明 App/iec60870 里没有对应实现,只作能力参照。
另外修掉 8 处把外部 DL/T 634.5104-2009 实施细则的章节号当成本仓自
引用的误报,以及 7 处指向供应商快照内测试文件的路径。IEC60870-Slave/
README.md 里 52 处 docs/ 链接同步改到新位置。
docs/README.md 登记:目录树加 iec60870/ 一行,新增 5.3 节列全 36 篇
的一句话索引,并说明它与子系统设计/IEC104上行设计说明.md 的分工
(前者讲协议库内部怎么实现,后者讲板端怎么接)。
验证:doc-links 由 30 处问题降到 0(308 个文档全过,脚本零改动);
mermaid 57 块围栏新发 0 处;全量 pre-commit 6 Passed / 0 Failed;
36 篇文件名合规、无 BOM、无 CRLF、无 U+FFFD。纯文档改动,不涉及代码
与构建。
|
2026-11-18 22:49:55 +08:00 |
|