首页 / 大项目模块 / 交付标准与留档规范

交付标准与留档规范

六条硬要求:沟通与协作 3 条 + 交付与验收 3 条。 每周周报的纪律自查就是照这个逐条过。 下半页是功能模块 / 大项目模块的留档差异——两者要求不一样,别混。

1. 沟通与协作

1.1 会议结论留痕

落地到本站 问题结论同时写进当周周报 + 问题留档库。 飞书消息会被刷掉,站点不会。

1.2 多方协作对齐边界

最容易漏的就是这条 「客户端能改,那就客户端改吧」是最贵的决定。 W36-04 就是典型:Params.Location 到底谁认, 不是客户端单方面能定的,得服务器 + 策划 + 编辑器三方对齐。

1.3 不熟悉的模块主动请教专业人员

2. 交付与验收

2.1 交付前请策划过效果

视频存哪 不要嵌进 HTML(体积会撑爆站点)。录屏丢到项目共享盘, 页面里用 <div class="attach"> 记路径。写法见 留档模板 §3.4。

2.2 大型功能模块留档

大型功能模块,需要留存两份文档:

文档内容给谁看
技术方案文档 设计思路 / 模块结构 / 关键实现 接手改代码的人、面试讲项目的自己
使用文档 配置方式 / 接入步骤 / 注意事项 策划、其他业务方

2.3 验收后跟进配置与表现

这条不做的代价,W36-01 就是 坠落重生的代码写对了、验收也过了,但策划后来把复活点 Entity 摆进了 StaticMesh, 线上就是「落点在门外」的 bug。代码正确 ≠ 玩家体验正确。
配置是功能的一部分,交付方要跟到配置落地为止。

3. 功能模块 vs 大项目模块

两个层级的留档要求不同,判定标准是会不会有别人来接手/接入。

维度功能模块大项目模块
目的 快速了解这个功能 + 快速定位 bug 同左,再加让别人能独立接手和接入
必备内容 ① 模块定位一句话
② 关键链路 / 时序
③ 踩过的坑 + 排查速查表
④ 可复用的技术与实现方式
功能模块的全部 +
⑤ 技术方案文档(设计思路 / 模块结构 / 关键实现)
⑥ 使用文档(配置方式 / 接入步骤 / 注意事项)
核心价值 日后遇到类似需求能复用思路 日后别人不问我也能用起来
录视频 能录就录 必须
落在哪 功能模块总览 大项目模块,一个项目一个目录
怎么判断算不算「大」 不看代码行数,看三个信号:① 有策划要配表/摆 Entity;② 有其他业务方要接入; ③ 涉及跨端(服务器/编辑器)约定。命中任意一条就按大项目模块留档。

4. 交付自查清单

功能交付前把这张表过一遍,勾不满就别说「做完了」。

[ ]
口头对齐的结论已在飞书群留痕 §1.1 · 谁负责什么、做到什么程度
[ ]
多方协作的职责边界已对齐并写下来 §1.2 · 接口和时序怎么衔接,写清楚
[ ]
不熟的模块问过更专业的人 §1.3 · 动画 / 相机 / 角色位移优先问,别造重复轮子
[ ]
策划已过效果 §2.1 · 不是自测通过,是策划本人看过
[ ]
录了演示视频并记下落盘路径 §2.1 · 大项目模块必须,功能模块能录就录
[ ]
技术方案文档已写(大项目模块) §2.2 · 设计思路 / 模块结构 / 关键实现
[ ]
使用文档已写(大项目模块) §2.2 · 配置方式 / 接入步骤 / 注意事项
[ ]
已跟进策划的实际配置并进游戏复测 §2.3 · 代码对了不算完,配置落地才算完
[ ]
npm run compile 过了并 grep 过产物 「0 错误」不等于真 emit,见 重构与加功能指南
[ ]
grep 过有没有第二套实现 / 第二个注册点 只改一套等于没改,这个项目里咬过最多次