4. 交付物清单与文档体系
交付验收最容易出现争议的地方,往往不是系统能不能跑,而是“到底该交什么、交到什么程度才算合格”。如果合同只写“提供源代码及相关文档”,验收时双方对“相关”二字的理解可能相差十万八千里。因此,交付物清单必须逐项明确名称、载体、版本、格式和验收标准,形成一份可勾选、可追溯的清单,而不是一句笼统的承诺。
一、交付物的分类与清单结构
软件项目的交付物通常分为四类:可执行产物、源代码、文档、过程与质量证据。可执行产物包括部署包、镜像、安装脚本、配置文件模板;源代码包括完整工程、第三方依赖清单、构建脚本;文档包括用户手册、运维手册、接口文档、设计说明;过程与质量证据包括测试报告、缺陷记录、验收测试用例及执行结果。清单应逐项列出交付物编号、名称、版本号、介质形式(如 Git 仓库、压缩包、纸质或电子文档)、责任人、交付时间和验收方式。
建议在清单中为每项交付物标注“必需/可选”和“验收方式”,例如源代码采用“仓库权限移交+构建验证”,部署包采用“在干净环境安装并启动成功”,用户手册采用“按手册独立完成一次典型业务操作”。这样验收时就有客观依据,而不是凭感觉判断。
二、源代码的规范与审核要点
源代码交付不是简单地把一个压缩包丢给对方。审核时重点看四点:完整性、可构建性、可读性和知识产权归属。完整性要求仓库包含所有自研代码、构建脚本、依赖声明和必要的资源文件,不能缺少关键模块或只给编译后的产物。可构建性要求在约定的环境中能够从源码重新构建出与交付版本一致的部署包,通常需要提供构建说明和依赖版本锁定文件。
可读性方面,应检查是否有基本的目录结构说明、关键模块注释、编码规范说明。知识产权方面,需确认第三方开源组件的许可证类型和合规使用,避免交付后产生许可纠纷。验收时可执行一次“从零构建”:在干净环境中按构建说明操作,若能在规定时间内成功构建并启动,则该项通过。
三、部署包与安装交付物
部署包应包含可执行程序、依赖库、默认配置模板、数据库脚本、启动停止脚本和版本说明。审核要点是:能否在目标环境中一键或按步骤完成安装,安装后服务是否正常启动,配置项是否有说明和默认值。对于容器化交付,应提供镜像地址、镜像标签、编排文件和健康检查配置。
验收时建议在独立于开发环境的测试环境中执行安装,记录安装耗时、报错信息和处理方式。若安装过程需要人工干预,应在部署文档中明确写出每一步操作和预期结果,避免验收现场临时摸索。
四、用户手册、运维文档与测试报告
用户手册面向业务操作人员,应包含功能说明、操作步骤、常见问题处理和界面截图,审核时重点看“能否让未参与开发的人独立完成一次典型业务操作”。运维文档面向运维人员,应包含系统架构、部署拓扑、启停步骤、日志位置、监控指标、备份恢复和故障处理流程。测试报告应包含测试范围、测试环境、用例清单、执行结果、缺陷统计和遗留问题说明,审核时关注测试是否覆盖合同约定的功能点和性能指标。
下面用一张图展示交付物清单与审核路径的关系,帮助在验收时快速定位每类交付物的审核重点。
五、清单落地与争议预防
把上述内容固化为清单后,建议在项目启动阶段就与甲方确认,并在每次里程碑交付时更新状态。验收前一周,双方对照清单逐项预检,把“缺失项”和“有争议项”提前暴露。对于确实无法在验收前完成的项,应形成书面备忘,明确补交时间和验收方式,避免在验收会上临时争论。
最后需要强调,交付物清单不是越厚越好,而是越明确越好。一份字段完整、判据清晰的清单,既能保护交付方按约履行,也能让验收方有据可依,是减少验收争议最基础也最有效的工具。