用途:为 PR 审阅、架构决策说明、数据与请求流文档、前后对比等场景生成自包含的 HTML 架构图。
主要能力:输出位于 {MAIN_REPO_ROOT}/diagrams/opik-{TICKET_NUMBER}-diagram.html 的自包含 HTML 文件,路径始终基于主仓库根目录(通过 git rev-parse --git-common-dir 解析),即使在 worktree 中运行也能保留文件。图中含“复制为图片”按钮,便于在 Slack、Jira、PR 描述中分享;采用暗色 GitHub 主题、语义化配色与响应式布局。可选章节包括请求/数据流、为何采用此方案(问题与方案对比)、按层分的变更文件、关键设计决策。按场景取舍:Bug 修复侧重前后流程、根因与安全防护;新功能侧重数据流、架构与变更文件;重构侧重前后架构与变更文件;跨组件则展示所有层及连接流。
使用方式:遵循 style-guide.md 的风格指南,使用 template.md 的 HTML 模板生成。
限制与注意事项:CDN 脚本需带 SRI 的 integrity 与 crossorigin 属性;Playwright 截图须用绝对路径;章节最多 4 个;不得嵌入原始 diff 内容或 Jira 评论;copy-as-image 脚本中 toBlob 可能返回 null,需做空值检查。