核心用法
contract-diagram 是一款将 AI 开发流程转化为可视化合约的协作工具。核心工作流包含六个阶段:
1. 触发与合约检查 — 用户通过 "lets diagram [PATH]" 指令启动,系统验证合约存在性与可编辑性
2. 图解管理 — 检查现有 Mermaid 图解数量,支持新建、认领或报错处理
3. 设计迭代 — 核心协作阶段,通过编号注释(1️⃣2️⃣3️⃣)标记待讨论问题、技术权衡或权限请求
4. 签核流转 — 达成一致的节点转为黄色 approved 状态
5. 开发实施 — 绿色 developed 标记实现完成,红色 blocker 标识阻塞需回退设计
6. 发布交付 — 虚线框 outside 表示系统外执行的用户自主环节
本地服务支持热重载(2秒间隔),端口 8080 实时渲染图解变化。
显著优点
- 可视化合约:将口头/文本需求转为结构化图解,大幅降低 AI 理解偏差
- 状态驱动:六色徽章系统(default/approved/blocker/developed/notes/outside)实现进度透明化
- 问题追踪:强制编号注释机制确保技术债务不被遗漏
- 轻量集成:零依赖设计,单一 Markdown 文件即可完成全流程管理
- 开发者友好:Mermaid 原生语法 + CSS 自动注入,无额外学习成本
潜在局限
- 单图解限制:每个 MD 文件仅支持一个 Mermaid 图解,复杂系统需拆分文档
- 状态同步依赖人工:徽章颜色变更需手动触发或 Wrapper 监测,无自动 CI/CD 集成
- 权限管控弱:注释中的破坏性操作/成本敏感操作仅靠文本标记,无硬性拦截机制
- 本地服务局限:localhost 模式仅适合个人开发,团队协作需自行解决端口转发与冲突
适合人群
- AI 应用开发者:需与 LLM 建立结构化交付约定的独立开发者或小团队
- 产品经理:希望用图解替代 PRD 降低与 AI 沟通成本的非技术用户
- 开源贡献者:MIT 协议允许自由改造,适合作为项目治理模板
常规风险
| 风险类型 | 说明 | 缓解建议 |
|---------|------|---------|
| 需求漂移 | 图解与实际代码实现分离,可能产生文档过期 | 建立 "图解即代码" 审查机制 |
| 阻塞堆积 | 红色 blocker 节点若长期未处理会导致流程僵死 | 设置 SLA 提醒,超期自动升级 |
| 误操作授权 | 编号注释中的权限请求可能被忽略或冒用 | 对破坏性操作增加二次确认 |
| 端口安全 | 本地 8080 服务若暴露于公网存在探测风险 | 默认绑定 127.0.0.1,生产环境禁用 |
来源评估
由独立开发者 nonlinear 发布,MIT 开源协议。无企业背书,但代码结构清晰、文档完备,属于个人开源项目的典型质量水平。