接口设计的核心不是把文档写得更厚,而是把“谁在什么条件下必须交出什么可核对物”写成双方都能执行的约定。如果供应商只交文档、不参与实施,你需要在两种模式下做选择:一种是文档即终点的验收模式,另一种是文档加实施支持的分段模式。选错模式,后续所有扯皮都源于同一个缺口——没人能判断文档是否真的可用。
第一种条件是:供应商的合同义务到文档交付为止,实施由你方或第三方完成。这时接口的重点是可独立执行的说明书,包括字段定义、判断规则、异常分支和验收样例。文档必须能让一个没参与前期沟通的人照着做出来。
第二种条件是:文档只是中间物,供应商仍要配合实施,比如远程答疑、审核配置结果、处理上线后的规则偏差。这时接口的重点是响应义务:谁在几个工作日内回复、回复到什么程度算完成、超出范围怎么计费。
两种条件都成立,但混用会出问题。最常见的错误是合同写“交付文档”,执行时却指望对方顺手把实施也做了。判断依据很简单:如果实施方不是文档作者,就必须在文档里补上可独立验证的样例;如果实施方就是供应商,文档可以简略,但响应时限必须写进接口。
多个角色对同一份文档有不同理解时,不要开会争论“写清楚没有”,而是把分歧拆成三类可核对项:
一个实际动作是:让实施方在读完文档后,只凭文档写出一份操作步骤清单,再和供应商的原始意图对照。差异点就是接口需要补充的地方。这个动作的结果会直接决定下一步——如果差异集中在少数规则上,补一份问答即可;如果差异遍布流程,说明文档模式本身不适用,需要改为分段实施支持。
无论选哪种模式,以下三个触发点不写清楚,接口就是空的:
假设一个场景:供应商交付了一份推广渠道配置文档,但没说明某字段在数据为空时如何处理。实施方按自己的理解填了默认值,上线后发现展示异常。如果接口里写了提问触发和答复时限,这个问题在配置阶段就会被暴露;如果没有,就只能等上线后回溯,而回溯时双方对“文档是否已说明”各执一词。
文档即终点的模式并非总是不可行。它成立的条件是:实施方具备同类项目的独立经验,且文档覆盖了全部判断分支。这时你可以接受供应商不参与实施,但要在验收项里加一条——由实施方出具一份“按文档执行后的差异说明”,列出所有需要自行补充的判断。这份说明就是接口的实际边界。
反过来,如果实施方是新手团队,或者项目涉及多个系统对接,文档模式的风险会集中在“没人能判断文档是否完整”上。这时更稳妥的选择是分段模式:文档交付后保留一个短周期的实施支持窗口,窗口内供应商只负责答疑和审核,不负责代做。窗口结束后的新问题按变更触发处理。
选择哪一种,不取决于供应商说“我们文档很全”,而取决于你能不能在实施前找到一个人,仅凭文档复述出完整操作路径。找不到,就选分段模式;找得到,文档模式加差异说明即可。