Files
STM32F4-Base/tools
wandering1 f48208f1c5 docs(配图): 生成器与产物清单并成一张唯一真值表,挂载列改由实测反推
两张清单各自登记同一批生成器,2026-10-30 实测各漏各的:
`tools/arch_diagram/README.md`「脚本一览」21 行缺 5 个(adc_health 三张、
net_instability、net_pending),`docs/架构设计/图形绘制流程.md` 的三列表 18 行
缺 9 个(多出的还在 `docs/架构设计/图形绘制流程.md` §2.1 另立一张表登记例外面)。
同一条事实两处登记必然漂,现并成一张:

- 唯一真值表 = `tools/arch_diagram/README.md`「产物清单」:按图逐行,32 张入库
  `docs/images/*.svg` 全量(26 个本目录生成器 + refgraph 2 张 + 无生成器的手工
  级联框 2 张),列 = 图 / 生成器 / 这张图答什么 / 顶部数据区(改这里 → 重跑)/
  挂在(`文档:行号`)。
- `docs/架构设计/图形绘制流程.md` §二 的逐脚本表换成指针(只留选型判据与流程),
  §2.1 保留「钩子扫不到的图」的维护口径、去掉与主表重复的表。
- 级联框两张的绘制日期按 `git log --follow` 改对:原写「2026-10-26 手画」与 git 史
  不符,实测 2026-09-08 `891c9ef0` 入库、2026-09-11 `2429955d` 随配图规范收拢进
  `docs/images/`,此后未再改动。
- `docs/门禁说明/generated-fresh.md` §8 旧口径「加生成器 = `GENS` 加一项」对
  `docs-svg` 不实:该条目声明 `dir` + `pattern = gen_*.py`,实跑 `glob.glob` 现扫
  (`scripts/check_generated_fresh.py`:146-150 与 :452)→ 新增生成器自动进扫描面,
  要同批改的是产物清单不是门禁。已拆成「加新类别」与「`docs-svg` 不必登记」两条。
- 「挂在」列由扫描 `![]()` 反推,并跳过 ``` 围栏与行内反引号里的示例写法——
  `docs/文档规范.md`:83、`draw-diagram` SKILL.md:155、本文档 §3.1 第 5 步
  那三处是教学示例、不是真挂载,先前手写表时误计进去过。
- 三张零内嵌图(`内存布局_RAM.svg`、`引用关系图.svg`、`引用关系图_模块.svg`)
  在表里明写「零内嵌」并给出被文字提到的位置。

`draw-diagram` skill 的落库义务同批改指:§二第 6 步与验证清单都指向「产物清单」,
并写明「全仓只此一张逐脚本清单」,避免下一个人再另起第二张。

自查:`check_doc_links.py --sections-strict` 三篇 rc=0;`check_generated_fresh.py`
PASS(26 生成器 / 22 一致 / 4 存量基线);`check_skill_size.py` 17 个 SKILL.md ok;
`check_mermaid.py --all` 31 文件 62 围栏新发 0;`check_bom_drift.py --all` 99 文件
无漂移;产物清单核对器(一次性,不入库)重写挂载列后复跑归零、再跑幂等。
纯文档与 skill 文案,未改任何生成器与代码,未 commit。
2026-10-30 16:54:53 +08:00
..

tools/ — 开发工具

面向开发者的功能性工具(生成器 / 转换器 / 交互工具)。 与 scripts/(质量门禁与度量)分工不同:本目录产出资产(图、字体、代码、知识库)。

工具一览

目录 工具 产物 文档
arch_diagram/ 架构图 SVG 生成器 docs/images/*.svg docs/架构设计/图形绘制流程.md
font_gen/ 中文字库生成 Drivers/BSP/UI/ui_font_cn_12.c docs/UI设计/UI_中文字体生成与配置.md
menu_gen/ 菜单树代码生成 UI 菜单代码 docs/UI设计/菜单页面设计.md
netlist_semantics/ 网表语义分析 引脚知识库 JSON + 网表报告 docs/硬件平台/
refgraph/ 文件引用关系图 docs/images/引用关系图.* docs/架构设计/引用关系图说明.md

使用方式

# 架构图(精确布局)
& '.venv\Scripts\python.exe' tools/arch_diagram/gen_memory_svg.py

# 中文字体(含新汉字文案后必须重跑)
& '.venv\Scripts\python.exe' tools/font_gen/make_font.py

# 引用关系图
& 'tools\refgraph\gen_refgraph.bat'

# 串口助手(常驻 daemon)
& '.venv\Scripts\python.exe' .dsh/skills/serial-assistant/scripts/serial_tool.py

⚠️ 约定

  • 生成器的产物与脚本一并提交(如 SVG);本地预览产物(如 PNG)不提交
  • 图表选型:精确布局图用 arch_diagram/ 生成器;拓扑图(流程/时序/状态机)用 Mermaid; 勿手绘 ASCII 框图(见 docs/架构设计/图形绘制流程.md)
  • 涉及 UI 改动:走 ui-verify skill 五步门禁;涉及字体:走 font-regen skill

相关文档

  • docs/架构设计/图形绘制流程.md — 配图规范与选型
  • docs/架构设计/引用关系图说明.md
  • docs/测试说明/测试工具/串口助手使用指南.md、docs/测试说明/测试工具/串口助手设计说明.md