kidoc 用于从 KiCad 工程文件生成专业工程文档。
用途:根据 .kicad_sch 与 .kicad_pcb,自动生成硬件设计说明(HDD)、CE 技术文件、设计评审包、接口控制文档(ICD)、制造转产包、原理图评审报告、电源分析报告、EMC 预合规报告,也支持通过 --spec 指定任意章节顺序的自定义报告。
主要能力:一条命令即可生成完整骨架——自动检测原理图与 PCB 文件,运行原理图、PCB、EMC、热分析,生成框图与原理图 SVG 渲染,并输出含预填数据表与叙述占位符的 Markdown 骨架。支持电源树、总线拓扑、架构等框图。原理图渲染支持整张图纸、子系统裁剪、网络高亮、引脚级网络标注;PCB 渲染提供 assembly-front、assembly-back、routing-front、routing-back、routing-all、power 等图层预设。
使用方式: python3 skills/kidoc/scripts/kidoc_scaffold.py --project-dir /path/to/kicad/project --type hdd --output reports/HDD.md 生成 PDF: python3 skills/kidoc/scripts/kidoc_generate.py --project-dir /path/to/kicad/project --doc reports/HDD.md --format pdf 首次运行会创建 reports/.venv/(仅 PDF/DOCX/ODT 需要,HTML 零依赖)。图元生成可用 kidoc_diagrams.py 与 kidoc_orchestrator.py。叙述部分由 agent 或人工撰写,替换 Markdown 中的占位符;重新生成时 <!-- GENERATED --> 标记内的数据自动更新,人工叙述保留。配置写在 .kicad-happy.json 的 reports 键下,支持用户级与项目级级联。
限制:原理图与 PCB 渲染仅支持 KiCad 6+ 格式;叙述章节需 agent 或人工编写,骨架只提供结构与数据;SPICE 仿真需手动设置,不会自动运行;PDF 矢量 SVG 嵌入优先用 svglib,无法解析时降级为栅格图。