用途:把架构图绘制标准化。核心流程是先写 spec.json(模式见 diagram-spec.md),再运行校验与渲染脚本,由脚本负责全部视觉决策,避免手写 mxGraph XML,从而让不同作者、仓库和会话产出一致。\n\n主要能力:支持 C4 上下文、容器、组件层级(每图只用一层,不混用);形状可带证据与置信度标注;可校验多视图清单;可导出为图片。ERD 可由数据库结构生成规格:python3 scripts/schema_to_spec.py db/schema.sql --title "<System> — ERD" -o spec.json。\n\n使用方式:python3 scripts/validate_spec.py spec.json 校验;python3 scripts/render_drawio.py spec.json -o docs/architecture/<slug>.drawio --strict 渲染(退出码 2 表示布局问题,应按 layout-rules.md 调整规格);相关视图可选运行 python3 scripts/validate_manifest.py view-manifest.json。导出优先用 draw.io MCP 工具,否则用 python3 scripts/export_drawio.py docs/architecture/<slug>.drawio -f png -o docs/architecture/<slug>.png,再退则交付 .drawio 并说明未导出图片。交接前需按正常阅读尺寸检查导出图片。\n\n约束与限制:JSON 规格是语义唯一来源,.drawio 是可编辑呈现,图片仅供演示;生成 XML 自带基线,重新生成默认保护手工修改,只有把语义变更回到规格后才用 --acknowledge-manual-edits。绘制前先明确受众与决策;按信息选图型而非习惯;边必须标注协议或事件(事件用 style: async);盒子上的数字来自 metric 或 constraint,不得编造;云图标仅限已验证来源,gcp:、aws: 为官方图标,其他厂商用 cloud: 并在 sublabel 写服务名,Azure 无官方图标故始终用 cloud:;高管受众图不超过 12 节点,超出按层级或流程拆分;图例与标题块由脚本生成,不要删除或重复。反模式包括手写 XML、编造盒子、混用层级、无标注箭头、未展开缩写、孤立节点。无证据内容应省略或渲染为 UNVERIFIED。资料未提供具体安装命令、收费或价格信息。
common-architecture-diagramming
部署与运维
更新于 10-15 22:13