如果供应商只交文档、不负责实施,接口设计的核心不是把文档写得更细,而是把“文档交付”和“系统或内容环境里的实际变更”拆成两个可验收的节点。需要退出旧合作关系、又保留仍有价值的部分时,先判断你能否自行实施:能自行实施,就按可独立执行的规格接口交接;不能自行实施,就要把实施责任重新写进合同或另找执行方,否则文档再多也不会自动变成可用结果。
两种条件下的选择不同,依据是团队是否具备对应的操作权限和技术能力。
判断依据可以看三件事:谁持有目标环境的账号权限;谁能在变更后做回归检查;出问题时谁负责回退。三件事都指向你方,才适合采用纯文档交付;只要有一件必须依赖对方,就应把实施写进接口。
文档型接口不等于“给一份说明”。它至少要包含目标对象、变更前后的对照、字段或栏目映射、审核责任和回退方式。一个可用的做法是要求每份文档都带一张变更清单,列出:改哪个页面或哪条记录、原状态是什么、目标状态是什么、由谁执行、执行后用什么现象确认。
假设某旧栏目需要退出,但其中一部分内容仍有保留价值。文档里如果只写“建议迁移并优化”,执行方无法判断迁移范围。改成“保留 A 类内容,映射到新栏目的 B 字段;C 类内容不迁移,保留原路径但不再更新”,执行方就能直接操作。这个动作的结果会决定下一步:如果执行后新栏目能独立维护,旧接口可以关闭;如果仍要回查旧文档才能维护,说明规格还没有真正交接。
这里要说明一个例外:如果目标环境本身不允许外部写入,纯文档交付是合理选择,但接口里要增加“你方执行、对方复核”的节点,并约定复核不通过时由谁补规格,而不是默认文档交完就结束。
这种情况下,接口要按动作而不是按文档章节划分。每个动作对应一个可观察结果:页面是否已按新结构呈现、旧链接是否已按约定处理、后台是否已能独立发布。文档只是动作的输入,不是完成标志。
一个注明假设的短例子:假设旧系统中有 200 条记录需要处理,其中 50 条保留、150 条退出。接口可以写成“供应商完成 50 条迁移并在新环境可查,150 条按约定停止对外呈现”。验收时抽查保留项能否在新环境打开、退出项是否不再出现在约定范围。抽查结果影响下一步:保留项可查、退出项不再出现,才进入权限交接;只要有一类不成立,就回到对应动作,而不是重新审一遍文档。
需要避免的误判是:文档里写了迁移规则,不等于迁移已经发生;后台出现一个新菜单,也不等于旧内容已经按规则处理。请求量或抓取量归零同样不能单独证明处理正确,它也可能是路径关闭、访问入口变化或统计口径调整造成的。
旧关系退出不等于全部推倒。接口设计应把“退出项”和“保留项”分开,并分别指定归属。退出项明确停止更新、停止对外呈现或归档;保留项明确由谁维护、维护需要哪些权限、缺少哪些资料会导致无法继续。
实际动作可以按顺序做:先列出保留项清单,再核对每项所需的账号、模板和审核规则是否已在你方手中;然后把退出项从日常流程中移除,最后关闭不再需要的接口。这个顺序的结果是:保留项能独立运转,退出项不再占用双方沟通成本。如果保留项仍依赖对方手里的权限,说明退出条件还不成立,应先完成权限交接再谈关闭。
例外情况是保留项本身价值已经很低,维护成本高于重新建立。这时可以把它归入退出项,但要在接口里写清判断依据,避免以后因为“当时没交接”而反复返工。
无论采用哪种条件,都建议在接口里加一个最小验证:由你方指定一个人,在不联系原供应商的情况下,按文档完成一次小范围变更。能独立完成,说明接口可用;卡在某一步,就把那一步补成明确规格或明确实施责任。这个动作不承诺收录或排名结果,只用来判断交接是否真的完成,以及下一步是关闭旧接口还是继续补责任。