SuperAPI AI 工具集

build-guide

办公与效率

查看项目

更新于 10-15 23:49

技能介绍

用途:为 packages/<domain>/ 下的指定项目生成或更新可打印搭建指南,输出到 <project-path>/docs/build-guide.{typ,pdf},面向从零开始组装与烧录硬件的人。与其他文档技能的区别:wiring-doc 面向开发者的引脚速查、project-readme 面向仓库快速上手,而 build-guide 是把 BOM、接线、供电、装配、烧录、验收合并成一份印在案头的文档。

主要能力:从权威来源采集数据,引脚等以 main/pin_config.h 为准,结合 WIRING.md、README.md、CLAUDE.md、sdkconfig.defaults、justfile、partitions.csv、main/CMakeLists.txt,以及 docs/schematics/images/<name>.png 原理图。识别板卡约束(PSRAM 模式、仅 3.3V GPIO、原生 USB-Serial-JTAG、GPIO 预算、strapping 引脚)。按需生成章节:Overview、Bill of Materials、System Architecture、Wiring Reference、Power、Assembly Steps、Build & Flash、First Boot & Provisioning、Functional Checkout、Troubleshooting,未使用的章节省略而非填充占位。

使用方式:样式与辅助函数位于 tools/typst/build-guide.typ,通过 #import "../../../../tools/typst/build-guide.typ": guide, callout, htable, theme 与 #show: guide.with(...) 驱动文档;提供 callout(title, body, kind)、htable(cols, header, ..rows) 与 theme。不要在项目文件中重复声明页面、字体、标题样式或表格颜色。编译时 Typst 不在容器工具链内,如缺失可安装 CLI:CARGO_HTTP_CAINFO=/root/.ccr/ca-bundle.crt cargo install typst-cli --locked。从指南目录以仓库根为沙箱根编译: cd packages/<domain>/<project>/docs typst compile --creation-timestamp 0 --ignore-system-fonts --root ../../../.. build-guide.typ CI 守卫会逐字节比对提交的 PDF,因此需使用守卫固定的 Typst 版本并保证可复现;提交 .typ 与 .pdf 两者,并在 README 中加入“Printable build guide”段落链接两个文件及重新生成命令。

限制:指南须基于真实项目数据,引脚、地址、通道、偏移均来自源码,源码与文字不一致时以源码为准;危险项(电压不匹配、共地、PSRAM 模式、下载模式)放入 warn/danger 提示框。绝不打印固件版本:模板的 version: 参数须保持未设置,docs/auto/ 下内容不得读取 version.txt,如需引用仅可按名称指明其为真源,否则提交的 PDF 会静默过期(见 issue #439)。不嵌入厂商引脚图或照片。未提供的收费、价格、平台等信息暂未提供。