Archify社区指南:如何提交你的架构图到Showcase画廊
【免费下载链接】archifyAgent skill for beautiful, verifiable architecture, workflow, sequence,>项目地址: https://gitcode.com/GitHub_Trending/arch/archify
Archify 是一个 Agent 技能(Agent Skill),能把你的系统描述转换成可验证的架构图、工作流图、时序图、数据流图和生命周期图,最终输出自带动效、可一键导出的自包含 HTML 文件。本文是 Archify Showcase 画廊投稿指南,带你走通"画好图 → 通过校验 → 填写投稿表单"的完整流程。
一、Showcase 画廊是什么
Archify 的画廊(Proof Lab)收录了经过完整校验的真实场景图,目前共有11 个场景、99 项自动化检查,全部记录在 docs/gallery/manifest.json 中。
每张入选的作品都会附带:
- 来源 JSON:可复现的 typed JSON 描述文件
- 交付凭证(Receipt):SHA-256 校验值与字节数,保证产物可审计
- 9 项布局检查:正交箭头、标签避让、图例间距、路径节奏等
- showcase 质量档位:比日常使用更严格的构图标准
你的图一旦通过审核,就会和这些示例一起出现在画廊里,并标注你的贡献署名。
二、先画一张值得投稿的架构图 🎨
投稿的前提是你已经能用 Archify 生成一张满意的图。不需要手写代码,直接在支持技能(Skill)的 Agent 里描述系统即可:
npx skills add tt-a1i/archify -g然后在对话中说:
"用 Archify 画一张:浏览器 -> API 网关 -> Redis 缓存 -> PostgreSQL 兜底 的架构图,展示 8~12 个核心组件和一条主路径。"
Archify 支持 5 种图类型,投稿前可以对照选择:
| 图类型 | 最适合 |
|---|---|
| Architecture | 组件、服务、存储、信任边界 |
| Workflow | CI/CD、审批流、工具调用 |
| Sequence | API 调用、缓存回退、异步链路 |
| Data Flow | 数据管道、PII 边界、消费方 |
| Lifecycle | 状态机、重试、终态 |
三、提交前必须做的校验:--quality showcase
画廊不接受"看起来差不多"的图,而是要求通过showcase 质量档位的完整校验。在archify/目录下运行:
node bin/archify.mjs validate <类型> <你的图.json> --quality showcase --json node bin/archify.mjs deliver <类型> <你的图.json> <输出.html> --quality showcase --json两条命令的区别见 archify/references/delivery-contract.md:
validate检查 JSON 源文件,失败时会返回机器可读的修复建议(稳定错误码 + 精确主体 + 可执行的修复手段),照着改即可deliver是原子交付:渲染出的 HTML 必须通过全部产物检查,才会替换旧文件,并输出含 SHA-256 的交付凭证
💡 凭证 JSON 是投稿表单的必填项,
deliver --json的标准输出可以直接粘贴。
四、投稿表单:一份完整清单 ✅
投稿入口是仓库的 Showcase Issue 表单,模板定义在 .github/ISSUE_TEMPLATE/showcase.yml。核心规则写在 CONTRIBUTING.md 中:Showcase 提交应包含提示词、Agent 客户端、模型、Archify 版本、脱敏 JSON、产物、凭证和如实的视觉审查状态。
| 表单项 | 填写说明 |
|---|---|
| 图类型 | 五选一:Architecture / Workflow / Sequence / Data flow / Lifecycle |
| Archify 版本 | 精确版本号(如2.12.0)或完整 commit 哈希 |
| Agent / 模型 | 使用的客户端(Codex、Claude Code、Cursor…)与确切模型名 |
| 原始提示词 | 你最初要求画图的那句话,涉密信息需脱敏 |
| 脱敏 JSON 源 | 粘贴或附上 typed JSON,保留复现所需拓扑 |
| 产物 Artifact | 截图 + 自包含 HTML / PNG / WebM |
| 校验凭证 | validate或deliver的完整 JSON 输出 |
| 视觉审查 | 二选一:通过 / 失败并注明缺陷(只看过浏览器实际效果,不是只看 JSON) |
五、脱敏与授权:3 道必勾的检查框 🛡️
提交前请务必完成三项声明,这是画廊的硬性门槛:
- 敏感数据检查—— 已删除访问令牌、凭据、私有仓库内容、个人/客户数据
- 分享权利—— 你创作了该提交,或有权利公开分享所有附件
- 公开展示授权—— 允许维护者在仓库、文档、画廊和官网中复现并展示你的作品,署名你的账号
⚠️ 维护者可能会要求你提供更小的安全复现样例。请保持拓扑完整,但把真实主机名、域名、账号换成占位符。可参考 archify/examples/product-analytics.dataflow.json 这种脱敏到"Web App / Event Stream / Warehouse"层次的写法。
六、画廊的验收标准长什么样
被接纳的图必须满足 showcase 档位的构图验收,manifest 里每张图都有对应记录。以画廊中的"Agent Tool Call Workflow"为例:
- 9 项检查全部
ok: true(正交箭头、标签与路由间距、关系走廊等) - 构图指标:0 交叉、0 模糊走廊、最小标签路由间距 29px、折点数在建议范围内
composition.status为pass,0 error / 0 warning
这些规则由standard与showcase双档位构成(见 archify/SKILL.md),showcase 失败必须对应真实且可修复的缺陷,不会误伤合理的路由设计。
七、通过审核后会发生什么
- 维护者用你提供的 JSON 复现图,并运行完整测试(
cd archify && npm test) - 场景源文件进入 docs/gallery/sources/,画廊经 scripts/build-gallery.mjs 重建后,你的图就出现在线上 Proof Lab 中
- 画廊页面标注你的贡献来源(attribution),见 docs/gallery.html
常见问答 💬
Q:必须提交真实项目的图吗?A:是的,Showcase 收录"真实、可复现"的图。教学性质的虚构拓扑也可以,但 JSON 必须能完整复现截图。
Q:校验一直失败怎么办?A:不要盲改。validate --json会给出diagnostics[],按其中的supportedFixes逐条修复;技能默认最多两轮修正,仍失败则说明问题在源拓扑本身。更多排查思路见 docs/authoring-cookbook.md。
Q:只想分享一张静态图,不提交 JSON?A:画廊以可复现性为核心,缺少 JSON 源和凭证的投稿无法通过验收。先把完整流程跑通,脱敏后再提交。
准备好你的第一张架构图了吗?用一句话描述你的系统,跑通deliver --quality showcase,然后把凭证贴进表单——你的作品可能就是下一个出现在 Archify 画廊里的场景图 🚀
【免费下载链接】archifyAgent skill for beautiful, verifiable architecture, workflow, sequence,>项目地址: https://gitcode.com/GitHub_Trending/arch/archify
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考