e4981aa2f6
AGENTS.md stopped being the store of record for build steps, Python env, hardware pins, doc conventions, log cost and task ownership. Those facts already live in docs, skills and role files; the entry file now only points at them. This commit moves every reference that used to name the entry file to the authoritative landing point, so a reader who follows a link arrives at the fact instead of at a sentence that no longer exists. What changed is links and prose, not behaviour. Code, scripts and tests only have comment and docstring lines touched; the only non-comment edit in the whole changeset is one note string inside the generated pin table JSON, and its generator was changed in the same step so the two stay byte-identical. New landing points created before the references were retargeted: - The console single-writer log design doc, section 7.1, is now the single authority for log cost: about 90 B flash and 216 B stack per DBG_ line, and the rule that deep call chains must predefine DBG_LINE_BUF_MAX. It also carries the full list of the twelve translation units that have tightened it, plus the grep command that decides the truth if the list and the code ever disagree. - The document writing standard, section 2, now holds the BOM list. - keil-build skill gains an exit code table: 0 success, 1 build failure, 2 BuildEnvError, 3 usage, 4 build lock held. This corrects a belief that was never actually written down anywhere: exit 2 does not simply mean environment error, argparse also exits 2 and the wrapper script was remapped so the two no longer collide. Regenerated and checked byte for byte: - The end-to-end architecture SVG in docs/images from its generator. - tools/netlist_semantics/pinout_kb.json from gen_kb.py. Both are idempotent; running the generators again produces no diff. Deliberately not touched, because machines read them: - scripts/check_bom_drift.py joins every line containing BOM and asserts four paths are present, so the entry file BOM line must stay one line. - scripts/gen_task_table.py reads the TASK_TABLE anchors directly. - scripts/rename_maps and scripts/archive keep their historical wording; they describe what happened, not what is true now. Verified: doc links report the same six pre-existing findings as the base commit and no new ones, generated-fresh passes, bom drift is clean across 101 files, and AGENTS.md itself is unchanged in this commit.
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-verifyskill 五步门禁;涉及字体:走font-regenskill
相关文档
docs/架构设计/图形绘制流程.md— 配图规范与选型docs/架构设计/引用关系图说明.mddocs/测试说明/测试工具/串口助手使用指南.md、docs/测试说明/测试工具/串口助手设计说明.md