知识卡片
数据接口文档守住底线
精简文档不能删掉稳定的数据结构和跨系统契约。数据文档说明实体关系、字段约束与字典;接口文档说明输入输出、编码、响应码和示例。变更影响多方,应审查兼容性并明确沟通确认。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- · 查看原书依据
接口文档是系统间的逻辑边界,设计不佳导致的再修改,会导致多方的级联改造工作。接口文档既然是契约,就意味着还是一份责任认定书,双方对接联调、处理生产故障时,问题出在谁身上,责任焦点就在于:报文是否按照接口文档准确发送?因此,对出具接口文档的责任性,以及关于接口变更的沟通工作,相关对接方应该足
参考来源
- 位置:《软件平台架构设计与技术管理之道》第05章《精进管理,磨练团队》(来源项目 book-sources,extracted/软件平台架构设计与技术管理之道/_epub-src/index_split_061.html)
- 结论依据:本节论述及案例支持核心想法;原文经验值不作为通用保证,纠错与读者延伸已在正文标明。
- 原始内容:接口文档是系统间的逻辑边界,设计不佳导致的再修改,会导致多方的级联改造工作。接口文档既然是契约,就意味着还是一份责任认定书,双方对接联调、处理生产故障时,问题出在谁身上,责任焦点就在于:报文是否按照接口文档准确发送?因此,对出具接口文档的责任性,以及关于接口变更的沟通工作,相关对接方应该足