项目交付给客户的文档清单
作为一个技术负责人，在项目交付给客户时，提供一套完整的文档是确保顺利验收和后续维护的关键。以下按交付阶段分类整理所需文档：
一、部署交付类（必须）
| 文件 | 说明 |
|---|---|
| 部署文档 | 环境要求、依赖版本、部署步骤、启动命令 |
| 环境配置说明 | 各环境变量含义、MinIO/数据库/MQTT 等中间件配置项 |
| 数据库初始化脚本 | 建表 SQL、初始数据 SQL |
| Docker / docker-compose 文件 | 如果有容器化部署的话 |
二、接口文档类（必须）
| 文件 | 说明 |
|---|---|
| 前后端接口文档 | 所有 API 的入参、出参、状态码说明（Swagger 导出或 Postman Collection） |
| 算法对接接口文档 | 算法服务的 API 文档，包含参数格式、返回格式、错误码等 |
| MQTT 消息协议文档 | Topic 规则、消息体结构、各事件说明 |
三、用户操作类（必须）
| 文件 | 说明 |
|---|---|
| 用户操作手册 | 面向最终用户，截图+步骤说明核心功能怎么用 |
| 管理员操作手册 | 后台管理、用户权限、任务管理等运营侧操作说明 |
四、系统设计类（视合同要求）
| 文件 | 说明 |
|---|---|
| 系统架构图 | 整体技术架构、各服务关系、数据流向 |
| 数据库设计文档 | 表结构、字段说明、ER 图 |
| MinIO 存储路径规范 | 文件存储的目录结构、命名规则、生命周期管理 |
五、测试验收类（必须）
| 文件 | 说明 |
|---|---|
| 测试报告 | 功能测试、接口测试结果 |
| 已知问题清单 | 遗留 Bug、临时方案、后续优化项 |
| 验收用例清单 | 对照需求逐条列出验收标准，客户签字用 |
六、源码类（视合同要求）
| 文件 | 说明 |
|---|---|
| 前端源码 | 含 README、依赖说明 |
| 后端源码 | 含 README、依赖说明 |
| 版本说明 | Git Tag 或版本号对应的功能清单 |
优先级建议
合同里没有明确约定的情况下，按这个顺序准备：
① 部署文档 + 数据库脚本 ← 客户能跑起来的前提
② 用户操作手册 ← 客户能用起来的前提
③ 接口文档 ← 后续对接/维护的前提
④ 验收用例清单 ← 保护自己，避免扯皮
⑤ 其余按合同要求补充验收用例清单特别重要，提前和客户对齐「哪些功能算验收通过」，避免交付后客户说「这个功能不对」但需求当时没写清楚的扯皮情况。