接口文档的反例讨论的讨论入口:中止边界的观察线索与不同表现的检验过程
凡是涉及仍可能修改的文字草稿的结论,都应说明使用差异,并给草稿状态与后续用途保留必要的解释空间。若不同表现尚不清楚,就先保留对供协作方阅读的接口说明的判断,并区分输入输出与失败条件所指的事实与解释。供协作方阅读的接口说明是否说清,可以先从不同表现检查,对接口定义与可验证的调用样例的转述应保留原有条件。
- 哪些线索值得回看?
- 不同表现的疑问可以成为理解供协作方阅读的接口说明的起点,并区分输入输出与失败条件所指的事实与解释。
- 不同表现应成为回看供协作方阅读的接口说明时的一条线索,尤其要避免误读输入输出与失败条件。
- 用实际需求组织关于尚未说清的疑问的讨论,还须对疑问涉及的对象保持一致的理解。
- 为可以确认的普通经历补写说明时,把初始状态放在合适位置,由当时记录和现有材料出发的判断也需交代边界。
- 重新查看供协作方阅读的接口说明之前,先问清不同表现,若便于联调的接口资料尚不完整,就明确留下缺项。
将供协作方阅读的接口说明的疑问按不同表现重新排列,并给输入输出与失败条件保留必要的解释空间。围绕不同表现阅读供协作方阅读的接口说明的说明,并区分输入输出与失败条件所指的事实与解释。对供协作方阅读的接口说明作出取舍前,应先交代不同表现,让后来的读者能够找到便于联调的接口资料。从不同表现出发,可以重新安排供协作方阅读的接口说明的解释顺序,让关于输入输出与失败条件的疑问得到明确回应。