结论先说:把“文档”当成验收对象,把“实施”拆成可由你方执行的操作单元,接口就设计成一份可执行规格加一次联合演练。供应商交不出可执行规格,只交说明性文档,就应该在付款节点前把缺口暴露出来,而不是等到上线阶段再补。
文档不实施,通常分两种情形。一种是供应商按合同只负责方案与规范,实施由你方或第三方完成;另一种是合同写了实施,但对方用文档替代交付。这两种的接口设计完全不同。
区分证据可以看三点:文档里是否出现具体账号、环境、参数、字段、触发条件;是否标注了执行顺序和回滚方式;是否写明谁在什么时间点做什么动作。只讲“建议配置”“可考虑接入”的,属于说明性文档;写到具体路径、字段名、判定阈值和失败处理的,才接近可执行规格。
假设情境:你方与一家营销推广公司签约,对方交付了一份推广渠道接入说明,但拒绝代为配置跟踪参数与转化回传。此时不要争论“该不该做”,而要把文档转成你方可以照着做的清单,再判断缺口在哪。
双方接口可以拆成数据接口、操作接口和责任接口。数据接口管字段与格式,操作接口管谁在哪个后台点什么,责任接口管出错时谁先排查。
一个实际动作:拿到文档后,先挑一条最关键的转化路径,按文档从头到尾走一遍,只记录卡住的步骤,不改文档。走完你会得到一份缺口清单,这份清单就是下一轮沟通的输入,而不是情绪化的催办。
文档评审容易停留在措辞层面,联合演练能直接暴露接口是否成立。做法是选一个最小可验证场景,双方各自认领动作,在同一时间段内完成。
演练结果只有三种:一次通过、卡在权限、卡在定义。一次通过说明接口可用,可以推进规模化;卡在权限说明责任接口没写清,需要补授权流程;卡在定义说明数据接口含糊,需要补字段取值和判定规则。三种结果对应三种下一步,不要混在一起谈。
注意边界:这个方法在单个渠道、单条路径上通常成立,但渠道数量增加后,例外会集中出现,比如某些渠道的回传延迟、字段截断或去重规则不同。此时不能直接照搬单渠道的接口结论,而要按渠道分组重新演练,否则规模化后会把个例问题放大成系统性返工。
如果供应商只交文档,付款节点就不应绑定“文档交付”,而应绑定“接口可执行”。可执行的最低标准是:你方人员按文档独立完成一次配置,且结果可被验证。
具体做法是把验收拆成两步:文档验收看结构与字段完整性,实施验收看独立复现结果。两步分开付款,文档款比例压低,实施款与复现结果挂钩。这样做的结果是,供应商有动力把文档写到可执行,而不是写到看起来完整。
如果对方坚持只交文档,那就明确把实施责任划回你方,并相应调整费用与时间预期。接口设计的核心不是让文档更厚,而是让责任边界在动作层面可验证。
出现以下情况时,不要继续加文档,而要回到接口本身:同一字段在两个文档里含义不同;关键步骤只有截图没有文字判定;异常处理写成“联系技术支持”而无响应时限;演练时双方对“完成”的理解不一致。
这些信号说明问题不在文档数量,而在接口没有落到动作和判定上。此时正确的下一步是缩小范围,只固定一条路径的字段、动作和验证方式,跑通后再扩展。跑通一条路径所花的时间,通常比反复评审整份文档更短,也更能暴露真实缺口。