| # | 缺什么 | 通俗解释(为什么缺、要包含什么) | 优先级 |
|---|---|---|---|
| 1 | 部署运维手册 |
为什么缺
怎么把整套系统装起来、跑起来的说明书。现在网关目录只有一句"怎么编译"的提示,RuoYi 的说明还是开源项目自带的那份,照着做装不起来。 要包含
|
P0 |
| 2 | API 接口详细文档 |
为什么缺
每个接口的"使用说明书"。现在只有接口名单,没有参数和返回说明;后台虽然内置了文本/视频接入文档,但没有内部计费接口和错误码表。 要覆盖
|
P0 |
| 3 | 数据字典 |
为什么缺
数据库表结构说明。现在只有数据库文件,每张表存什么、字段代表什么、状态数字什么意思,得靠翻代码猜。 要包含
|
P0 |
| 4 | 账号与配置清单 |
为什么缺
所有账号密码和系统设置项的汇总表。现在密码散落在配置文件里,系统里有哪些配置、分别填了什么值也没有清单。 要包含
注意:复核发现回调验签密钥
ruoyi.callback.secret 不在 sys_config 表里,实际是代码里的默认值加启动脚本环境变量,清单里要按实际情况写清楚,别照抄原清单。 |
P0 |
| 5 | 验收测试材料 |
为什么缺
证明系统真能正常工作的材料。复核发现定制代码(计费、视频调度、回调)没有任何测试,验收没抓手。 要包含
|
P1 |
| 6 | 架构图源文件 |
为什么缺
交付文档里只有一张架构图截图,以后想改图(比如加个新系统)就得重画。 要包含
|
P2 |
| 7 | 版本说明 |
为什么缺
没有正式版本号和变更记录。网关的版本号文件 要包含
|
P2 |
| 8 | 业务计费规则说明 |
为什么缺
计费规则说明书。现在怎么收费全得从代码里反推。 要包含
特别注意:原清单提到的租户视频任务上限
video_task_max,复核时在两套代码里都没找到对应实现,需要对方说明是没实现、还是漏交付了。 |
P2 |
| # | 问题 | 通俗解释(在哪里、严重在哪) | 要求 |
|---|---|---|---|
| 9 | 安全 密码直接写在交付包里 |
问题
生产环境的真实密码暴露在代码和配置文件里,谁拿到交付包都能看到。 位置
|
密码改成占位符,真实密码走安全渠道单独交接;已经暴露过的密码建议全部更换 |
| 10 | 安全 数据库备份里带着真实密钥和用户数据 |
问题
原清单只说"密钥移交待确认",复核发现更严重:密钥已经直接在交付包里了。 位置
|
先换发渠道密钥、清理真实用户数据,脱敏后再交付 |
| 11 | 部署 一键部署文件会装出"阉割版" |
问题
网关目录里的 位置
|
换成定制版的构建/部署文件(自建镜像或本地编译),RuoYi 侧一并补齐 |
| 12 | 部署 Nginx 配置和交付文档对不上 |
问题
交付文档说 Nginx 承担反向代理和限流,但交付包里的 位置
|
补网关反代、限流配置示例,并和交付文档保持一致 |
| 13 | 清理 混进运行日志、临时文件和编译产物 |
问题
交付包里带着别人机器上跑出来的东西,既不专业也可能泄露运行细节,整包 1.4GB 也过大。 位置
|
清理运行日志、临时文件、编译产物后重新打包 |
| 14 | 清理 数据库备份有两套,容易拿错 |
问题
同一份数据库给了两份备份,日期还不一样,部署时拿错版本数据对不上,排错很痛苦。 位置
|
明确以哪套为准,删掉旧版或在文件上注明版本 |
| 15 | 质量 交付 PDF 没校对好 |
问题
比原清单说的更严重:目录和正文不仅编号对不上(两个 3.2),目录里还有两节正文根本没有。 位置
|
按正文实际章节修订目录和编号后重新发一版 |
| 16 | 交付形态 git 仓库不完整 |
问题
顶层 git 仓库把两个源码目录记录成了"子模块链接",但没有 位置
|
补好子模块引用,或改用完整目录压缩包交付 |
| 17 | 缺失文件 代码引用的 SQL 文件不在包里 |
问题
网关代码注释里写着索引由 位置
|
补上该 SQL 文件,或修正代码注释并说明索引维护方式 |
| 18 | 文档 网关说明没更新,还写反了 |
问题
网关 README 只有两行,还写着"计费、租户管理都移除"——实际计费是自研接入的,正好相反;环境变量说明也没跟上。 位置
|
按实际功能重写 README 和环境变量说明 |
| # | 事项 | 通俗解释(为什么要问) | 类型 |
|---|---|---|---|
| 19 | 第三方 SDK 授权确认 |
为什么问
系统里嵌了别人家的代码,得确认能不能用,避免后续版权和合规风险。 位置
|
合规 |
| 20 | 上游平台密钥交接 |
为什么问
系统要调用火山引擎、移动云的模型能力,渠道 API Key 的来源和交接方式需要明确。 特别注意:密钥已经在交付的数据库备份里出现过,务必先换发新密钥,再通过安全渠道交接。
|
凭据 |
| 21 | 开源协议商用确认 |
为什么问
系统基于两个开源框架二次开发并用于商业项目,需确认许可是否允许,以及需要保留哪些声明。 位置
|
合规 |