结论先给:如果供应商只交文档、不参与实施,双方接口要按“文档即交付物”来设计,把可执行性验证、变更责任和验收标准全部前移到文档阶段;否则文档交付完成之日,往往就是实施扯皮的开始。这个结论成立的前提是,你方或第三方具备独立实施能力,且合同允许你方对文档提出修改要求。若供应商仍掌握唯一的环境配置权限或数据字典解释权,接口设计得再细也会失效。
很多团队把“只交文档”理解成一份说明书,实际至少包含三类内容:接口契约(字段、协议、错误码、鉴权方式)、环境与依赖清单(版本、配置项、外部服务)、实施步骤与回滚方案。三者缺一,实施方就要靠猜。
判断文档是否够用,不看页数,看一个动作:让实施方在隔离环境里按文档独立调通一个最小请求。调通说明契约自洽;调不通,缺的往往不是文字,而是供应商没写出来的隐含约定。
只交文档的场景下,口头承诺没有约束力。接口约定应作为文档的正式章节,至少覆盖:
这些内容写进文档后,验收标准就变成可核对项,而不是“感觉能用”。
假设供应商交付了完整字段表和示例报文,你方按文档实施后调用失败。查下来发现,文档写的是测试环境地址,生产环境需要额外申请白名单,而白名单流程只有供应商内部知道。此时文档没有错,错在接口设计遗漏了“环境准入”这一环。
这说明:只交文档时,任何依赖供应商内部流程的环节,都必须显式写成接口的一部分,否则文档再规范也无法独立实施。反过来说,如果所有外部依赖都能在文档里定义清楚,只交文档就是可行的。
建议在文档交付后设置一个“独立复现”节点:由实施方在不联系供应商的前提下,按文档完成一次完整调用并记录卡点。卡点分为文档缺陷和环境依赖两类。
文档缺陷由供应商修订,修订后再复现一次;环境依赖若无法消除,就转为供应商的有限配合义务,写进交付范围。这个动作的结果直接决定下一步:能独立复现,就进入正式实施;不能,就先谈补充交付,而不是先开工。
只交文档的供应商,交付边界容易在实施阶段被重新解释。排期上应把文档验收和实施启动分成两个独立节点,中间留出修订窗口。付款条件与这两个节点挂钩,而不是与“文档提交”挂钩。
同时明确一点:文档修订次数和响应时限要写清楚。没有这条,实施方每次遇到歧义都要等,排期会被动拉长。
最后,把“文档能否支撑独立实施”作为选择供应商的一项硬指标。网络公司排名再靠前,如果交付模式是只交文档,也要用独立复现这个动作来验证,而不是用文档厚度来判断。