先给结论:如果供应商明确只交付文档、不进入实施,你要把“接口”从口头配合改成可验收的输入输出约定——每份文档必须对应一个下游动作、一个责任人和一套可判定的完成信号。否则文档再厚,实施方也只能靠猜,返工成本会落在你身上。
“只交文档不实施”并不只有一种情况。选择接口设计方式前,先确认你处在下面哪一种结构里,因为两者的代价完全不同。
判断依据不是供应商怎么说,而是合同里有没有实施、部署、联调这类动词,以及验收标准写的是“提交文档”还是“系统可用”。如果验收标准只写了提交文档,就按结构一设计,不要假设对方会顺手帮你落地。
很多人把接口理解成一份接口文档,这是最常见的误判。真正能减少返工的接口,至少包含三样可核对的东西。
把文档拆成实施方真正要消费的条目,例如页面结构说明、字段定义、状态流转规则、素材规格、第三方依赖说明。每条都要写清“缺少它会导致哪个动作无法开始”。这份清单的作用是让缺失项提前暴露,而不是等到开发中途才发现。
文档里出现的每个待定项,都要指定由谁拍板。常见做法是把待定项分成两类:供应商能依据已有信息给出的,和必须由你业务方确认的。前者写进文档,后者单独列成待确认清单,避免实施方把两类问题混在一起反复追问。
不要用“已提交”“已确认”这类模糊状态。可判定的信号例如:实施方按文档完成一个最小流程并能复述字段含义;或按文档搭建出一个可点击的原型页面。信号越接近真实动作,越能暴露文档里的漏洞。
同样是只交文档,选择哪种接口强度,取决于下面两个条件。
如果实施方与你长期配合、沟通成本低,接口可以偏轻:以输入清单和待确认清单为主,允许在实施过程中边做边补。代价是文档的完整性依赖双方默契,一旦人员变动,隐性知识会流失。此时的实际动作是:要求供应商在交付时附一份“未决问题清单”,并约定每个问题的默认处理方式。结果是实施方遇到空白时有据可依,而不是停下来等回复。
如果实施方是外部团队、甚至要通过比价确定,接口必须偏重:文档要能脱离供应商独立被读懂,字段、状态、异常路径都要写全。代价是前期文档工作量明显增加,交付周期可能拉长。此时的实际动作是:把“实施方能否仅凭文档完成一个最小流程”写进验收条件。结果是文档质量从主观评价变成可验证事实,后续扯皮空间变小。
两种选择没有绝对优劣。轻接口省时间但怕换人,重接口费时间但抗交接。你的选择应该由“实施方会不会换”和“文档要不要给第三方看”这两个问题决定。
假设某项目由供应商只交付页面结构文档和字段说明,实施由另一家公司完成。如果文档只写了字段名称,没写字段为空时页面如何显示,实施方通常会自行决定:可能隐藏、可能显示占位符、可能报错。三种做法都“说得通”,但上线后表现不一致,排查时又找不到依据。反过来,如果文档里对每个字段标注了“为空时的显示规则”,实施方就能直接照做,验收时也能对照检查。这个例子的重点不是字段本身,而是接口有没有把判断权提前分配清楚。
无论选轻接口还是重接口,都要约定变更处理方式。文档交付后需求发生调整时,谁来判断这次调整属于“文档补充”还是“范围变更”,直接影响后续费用和责任。建议在接口约定里写明:变更请求先由你方汇总,再交由供应商判断是否在原交付范围内,实施方不直接向供应商提变更。这样做的结果是信息流有单一入口,避免多头沟通造成版本混乱。
最后提醒一点:文档交付量、页面数量这类指标归零或激增,都不能单独证明接口设计正确。它们可能来自需求变化、统计口径调整或实施节奏波动。真正能说明问题的,是实施方能否在没有额外解释的情况下推进下一步——这才是接口是否成立的判断标准。