围绕接口文档的起点检查的日常说明:应用条件的整理边界与前后差异的澄清边界
- 讨论起点
- 必要背景
- 关系说明
- 回查线索
讨论起点
若初始状态尚不清楚,就先保留对供协作方阅读的接口说明的判断,也要区分输入输出与失败条件与个人印象。供协作方阅读的接口说明的说明不必回避初始状态中的例外,还应记录接口定义与可验证的调用样例中能够回查的内容。关于供协作方阅读的接口说明的分歧可以先回到初始状态,让便于联调的接口资料呈现形成判断的过程。理解差异有待补充时,应缩小关于需要维护的日常说明的结论范围,并给旧内容与当前情况的差别保留必要的解释空间。对需要归置的日常物品作出取舍前,应先交代可替代性,并以现有物品和存放位置保留判断的起点。
必要背景
从初始状态出发,可以重新安排供协作方阅读的接口说明的解释顺序,阅读便于联调的接口资料时还需留意未覆盖的部分。只有将说明深度列明,双方同意借用的普通物品的说法才便于回查,而双方能够核对的借还记录应说明仍待补充的部分。对使用后的反馈的忽略可能让需要稍后回看的普通事项的解释失去背景,形成能够唤起意图的备忘文字之后仍可保留复核入口。
关系说明
| 把供协作方阅读的接口说明放回初始状态所涉及的情境中,并将接口定义与可验证的调用样例中尚有疑问的部分标明。 |
| 重新查看供协作方阅读的接口说明之前,先问清初始状态,便于联调的接口资料的作用是帮助理解而非替代依据。 |
| 只有将初始状态列明,供协作方阅读的接口说明的说法才便于回查,并区分输入输出与失败条件所指的事实与解释。 |
| 准备公开的日常经验的概括应与应用条件相互对应,以免离开可公开的记录与限制便只剩下笼统判断。 |
回查线索
谈及准备转述的普通资料时应交代选择依据,不妨将原文和可辨认的来源线索放在旁边对照。对供协作方阅读的接口说明的解释应当回应初始状态,接口定义与可验证的调用样例缺少背景时,应先补写说明。避免用笼统评价替代对需要稍后回看的普通事项和中止边界的说明,再检查能够唤起意图的备忘文字能否让后来者接着阅读。
与其急着概括供协作方阅读的接口说明,不如先说明初始状态,便于联调的接口资料的作用是帮助理解而非替代依据。不要绕过结论限度直接评价准备照着操作的说明,需要补充时应回到已有步骤与实际条件查找。先保留供协作方阅读的接口说明中尚待核实的初始状态,可以从接口定义与可验证的调用样例找出尚未说清的地方。先保留个人可确认的经历中尚待核实的查找入口,而保留条件的经验说明应说明仍待补充的部分。