交接指南
交接前验证。
协议交接在消费者真正能用之前不算完成。本清单确保在你团队和他们团队之间没有任何东西丢失。
清单
定义
- 所有消息类型都用精确的字节偏移定义
- 字段数据类型和长度明确无歧义
- 所有数值字段都指定了有效范围
- 枚举字段有完整的值列表
文档
- 每个字段都有添加上下文的描述,而不仅仅是重复名称
- 多消息流程有消息序列图
- 错误处理有具体代码和条件的文档
- 示例覆盖边缘情况,而不仅仅是正常路径
验证
- 沙箱反映实际协议行为
- 测试负载覆盖正常、边界和错误情况
- 消费者可以访问运行自己的验证
集成
- 集成脚手架从同一来源生成
- 导出格式匹配消费者需要的
- 未来变更有版本跟踪