wandering1
f754d59218
分层：流程与规范/ 单元测试/ 板级测试/ 专项验证/ 测试工具/ 测试数据/， 顶层只留新增的目录导航 README.md（归层判据 + 硬约束 + 本次处置记录）。 - 搬迁 28 个路径：测试数据三个目录 58 个文件为纯改名（R100，内容逐字节不变） - 全库引用同步 124 个文件：AGENTS / docs 索引 / skills / 门禁注释 / scripts - 门禁面：scripts/check_test_traceability.py 的 glob 改 rglob （分层后不递归扫描＝追溯门禁直接瞎掉） - scripts/rename_ref.py：收尾的 ℹ 提示在 GBK 代码页抛 UnicodeEncodeError， 让进程以退出码 1 收场而改写其实已落盘（RC 与真实结果相反）；改为把 stdout/stderr reconfigure 成 UTF-8，与 check_doc_links.py 等同法 - docs/文档规范.md §1.1 补「子目录文件过多时再分一层」；§3.6 补 rename_ref 搬整目录的两个实测坑：① 会改写目录内部文件的内容 ② 内部文件的 ../ 出链 不补层级（本次 23 个被误改的证据文件已按 HEAD 原始字节逐字节还原） - docs/README.md §6 改为与六个子目录一一对应，并补登原先漏登记的 「启动日志原子性复验流程」一行 - .cubemx_survival_baseline.json：App/util/task_watchdog.c 的注释路径也随分层更新， 该文件是存活审计的 watchdog-module 漂移锚点，按脚本自己的提示跑 --write 重建基线 （实测重建后仅 watchdog-module 一条哈希变化） - 铁律 4 例外（本次在任务树里改了单写者文件）：AGENTS.md 与 .pre-commit-config.yaml 只被 rename_ref 改写路径字面量（后者全在注释行）， 任务表块与钩子声明一字未动 验证：check_doc_links.py --sections-strict 覆盖全部 88 个改动 .md 全绿； check_test_traceability.py 输出与主树逐行一致；196 个文本文件无 BOM、无新增 CR、无 U+FFFD、无行尾空白；陈旧引用面由主树 25 处降到 6 处（无新增断链）。
44 lines
1.9 KiB
Markdown
44 lines
1.9 KiB
Markdown
# 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` |
|
||
|
||
## 使用方式
|
||
|
||
```bash
|
||
# 架构图（精确布局）
|
||
& '.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`
|