核心原则
字段级精度
每个字段应该有精确定义——偏移、长度、数据类型、有效范围。不是'通常大端'而是'字节0是最高有效位'。
上下文优先于文字
不要用段落解释字段,让消费者在上下文中看到字段——相邻字段、关系、约束。
有效的例子
展示有效负载的样子,而不仅仅展示规格说明的内容。一个好例子比一页文字更能防止问题。
沙箱访问
让消费者在构建前针对实际协议测试负载。他们发现问题,而不是你。
要避免的
- 用模糊描述如'通常'或'典型'来记录字段
- 用文字描述字节布局而不是精确位置
- 只提供展示正常路径的示例负载
- 与协议定义分离存在的文档