以图表作为AI开发共识的合约
图例: 说明: 尚未讨论
功能概述
图例: 说明: 尚未讨论是一项面向实际任务的技能,主要用于利益攸关方已商定;需要讨论/未执行( 总是有说明);
核心要点
- 已商定和执行;
- 已执行但开发者已作出决定( 在说明中);
- (已执行)。
使用与执行
它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。使用时应结合输入条件选择合适的执行方式,核对必要参数、依赖环境与输出内容,并按原始要求处理异常情况。该技能适合需要稳定复用相关能力的场景,可作为自动化工作流的一部分,也便于后续检查、调整和扩展。从功能定位来看,该技能强调把分散的操作要求整理成清晰、可复用的处理流程,使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。
结果检查与注意事项
实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数,再依据技能说明逐步执行;若输入条件不完整,应先补齐信息或采用保守配置,避免因错误假设导致结果偏离需求。执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期,并对异常提示、缺失字段和边界情况进行处理;涉及批量任务时,还应保存进度,避免中断后重复操作。
| 图例 | 说明 |
|---|---|
| 尚未讨论 | |
| 利益相关方已达成一致 | |
| 需进一步讨论 / 实现失败(始终附有备注) | |
| 已达成一致并完成实现 | |
| 已实现,但由开发人员自主决策(见备注) | |
| (虚线边框)需在系统外部执行 |
SKILL 合约流程图 ℹ️
%%{init: {'theme':'base','themeVariables':{"primaryColor":"#4A90E2","primaryTextColor":"#fff","primaryBorderColor":"#2E5C8A","lineColor":"#666","secondaryColor":"#50E3C2","tertiaryColor":"#FFD700","edgeLabelBackground":"#666"},'flowchart':{"nodeSpacing":50,"rankSpacing":50,"padding":15,"curve":"basis"}}}%%
flowchart TD
TRIGGER["触发器 + 合约"]
CHECK_CONTRACT{"是否存在合约?"}
OPEN["打开合约"]
CLARIFY["澄清需求"]
CHECK_DIAGRAM{"是否存在流程图?"}
CREATE["新建 1️⃣"]
CLAIM["已认领 1️⃣"]
ERROR["错误 2️⃣"]
DESIGN["设计阶段"]
SIGNOFF["准备审批"]
DEVELOPMENT["开发中..."]
BLOCKERS{"是否存在阻塞项?"}
TESTS{"是否通过检查? 3️⃣"}
PUBLISH["发布 3️⃣"]
TRIGGER --> CHECK_CONTRACT
CHECK_CONTRACT -->|是| OPEN
CHECK_CONTRACT -->|是,但
不可编辑| ERROR
CHECK_CONTRACT -->|否| CLARIFY
CLARIFY --> TRIGGER
OPEN --> CHECK_DIAGRAM
CHECK_DIAGRAM -->|是,且
存在多个| ERROR
CHECK_DIAGRAM -->|是,仅一个| CLAIM
CHECK_DIAGRAM -->|否| CREATE
CREATE --> DESIGN
CLAIM --> DESIGN
DESIGN --> SIGNOFF
SIGNOFF -->|已批准| DEVELOPMENT
DEVELOPMENT --> BLOCKERS
BLOCKERS -->|是| DESIGN
BLOCKERS -->|否| TESTS
TESTS -->|是| PUBLISH
TESTS -->|否| DESIGN
classDef default fill:#e0e0e0,stroke:#666,color:#000
classDef approved fill:#FFF9C4,stroke:#F9A825,color:#000
classDef developed fill:#D5F5D5,stroke:#388E3C,color:#000
classDef blocker fill:#FFCDD2,stroke:#D32F2F,color:#000
classDef notes fill:#E3F2FD,stroke:#1976D2,color:#000
classDef outside fill:#D5F5D5,stroke:#388E3C,stroke-dasharray:5 5,color:#000
class CHECK_DIAGRAM,CREATE,CLAIM,ERROR,SIGNOFF,DESIGN,DEVELOPMENT,BLOCKERS,CHECK_CONTRACT,OPEN,CLARIFY,TRIGGER developed
class PUBLISH,TESTS outside
1️⃣ 封装器在首次加载时自动注入标题 + 阶段徽章 + CSS,并持续监听徽章所标识阶段的变化。
2️⃣ 多个流程图会导致系统混淆。目前为保障正常运行,每个 Markdown 文件仅支持一个流程图。
3️⃣ 检查与发布行为取决于最终产物的内容及目标位置,因此由用户自行判断和决定。
编号备注(1️⃣ 2️⃣ 3️⃣)
使用时机:
执行前(设计阶段):
- 需组织讨论的问题
- 需做出权衡取舍的决策点
- 需求不明确或存在歧义的部分
执行过程中:
- AI 无法独立解决的错误
- 需要人工授权的操作(如破坏性操作、涉及成本影响等)
- 实现路径存在模糊或不确定之处
格式规范:
### 1️⃣ [组件名称] - [问题标题] **问题/错误:** ... **上下文:** ... **可选方案:** A、B、C **所需支持:** 决策 / 授权 / 协助
未编号的备注仅作解释说明之用;经批准后将显示为黄色。
本地开发环境触发方式
触发指令: “lets diagram [PATH]”
前提假设: 指定 PATH 路径下的文件已包含 Mermaid 流程图。
执行动作:
- 启动本地服务器(端口 8080)
- 在浏览器中打开对应流程图页面
示例:
User: "lets diagram epic-notes/webhook-contract.md" AI executes: cd ~/Documents/skills/contract-diagram/engine ./serve.sh & open "http://localhost:8080/?md=../../epic-notes/webhook-contract.md"
默认启用热重载功能(刷新间隔为 2 秒)。
热门AI工具
相关专题
本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。
0
2026.11.12
本专题围绕Go-Zero的安装与工具链配置展开,讲清Go版本要求、goctl安装方式、代理镜像、protoc依赖与环境变量设置,说明多版本共存、升级回退与CI流水线安装的做法,并整理安装阶段的常见报错与验证步骤。
0
2026.11.12
本专题整理Go-Zero的入门知识,从框架定位、环境准备到跑通第一个API服务,讲清目录分层、配置加载、日志与中间件的基本用法,并对比Gin、Kratos的差异,帮助Go开发者建立整体认知,判断它是否适合当前项目。
0
2026.11.12
本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。
0
2026.11.06
围绕Postman HTTP请求头配置展开,讲解Headers选项的具体使用方式,包括Key和Value参数填写、请求头信息添加、常见Header字段设置及请求头修改方法,帮助用户解决接口调试过程中遇到的请求头配置问题。
0
2026.11.06
详细介绍Postman接口请求的创建与发送方法,涵盖GET和POST请求、URL配置、请求参数、Headers请求头、Body请求体设置以及响应结果查看,帮助用户掌握Postman接口请求的完整操作流程。
0
2026.11.06
DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。
0
2026.11.05
DBeaver安全防护专题,围绕数据库连接安全、账号密码保护和访问权限管理展开,整理SSL/TLS加密连接、SSH隧道、数据库凭据保存及证书验证等配置方法,同时介绍敏感信息保护、远程连接风险和高权限账号使用等注意事项,帮助用户提高数据库日常管理的安全性。
0
2026.11.05
本专题聚焦DBeaver数据库连接配置与管理,覆盖从新建连接、选择数据库类型到填写连接参数和验证连接的完整流程。针对MySQL、PostgreSQL、SQL Server等常见数据库,整理相应的连接设置方法,并提供驱动缺失、认证失败和连接异常等问题的排查方向。
0
2026.11.04
热门下载
相关下载
精品课程
共6课时 | 12.1万人学习
共79课时 | 161.8万人学习
共6课时 | 54.7万人学习
最新文章