版本 | 日期 | 修订人 | 描述 |
---|---|---|---|
V1.0 | 2024/12/8 | nick huang | 创建文档 |
背景
前段时间,一位同事问我:公司有没有《上线剧本》的模板?
我说:没有哦,我之前写过一些上线剧本,可以发你参考一下。
可能有些同学对如何写上线剧本还没有概念,这里分享一下,大家可以做个参考。
哪些场景下,需要写上线剧本
上线剧本,由于不是每次上线都编写,所以有些同学可能比较少写,而在下面这些场景下,产品同学或质量同学可能提出需要上线剧本:
1、关键特性上线
2、较大型的特性上线
3、开发持续时间较长的特性上线
4、新应用上线
5、明显感觉上线内容较复杂的版本上线
6、等等
上线剧本是什么
指导"软件上线工作"能按时 、按质 、按量进行的执行剧本。
上线剧本包含的内容
一般,我会将上线剧本划分3个时间阶段的内容:
1、上线前影提前完成的工作
2、上线执行工作
3、上线后需执行的工作
上线前提前完成的工作
有很多实施内容是需要上线前提前准备好的,避免上线当天来不及或者手忙脚乱。
事项 | 责任人 | 时间要求 | 进展 | 备注 |
---|---|---|---|---|
开发报告 | Apple | 至少为上线前一天 | 已完成 | 本行为样例 |
测试报告 | Boy | 至少为上线前一天 | 进行中 | 本行为样例 |
提前预约上线当天需配合的人员的时间 | Cat | 至少为上线前一天 | 待处理 | 本行为样例 |
等等 |
为什么有些事情要提前完成?以我的感觉有两个原因:
1、有些事情必须提前准备,因为持续时间长 ,或存在不可控因素 。比如,需要申请一个域名,这涉及其他人员的协作和审批,时间周期长且不可控因素强,所以我们必须提前处理好;
2、有些能提前也能不提前处理的事情,我一般尽量提前处理,给上线当天留足余量。
Tips
如上面"提前预约上线当天需配合的人员的时间"所说的。
并不是所有的参与人员都那么紧密参与,比如跨部门合作的配合人员,他们可能每天配合多个部门的上线活动,难免有遗漏和忘记 的情况。
我们可以提前半小时和提前1天,提前提醒一下需要参与的人员,避免临时忘记了。
上线执行工作
"上线前提前完成的工作"的时间要求,我一般描述得在某个时间点之前。
而"上线执行工作"的时间要求,则需要比较细致,因为上线的时间周期比较短,需要各方人员在短时间紧密配合。
事项 | 责任人 | 时间 | 进展 | 备注 |
---|---|---|---|---|
提前30分钟提醒需配合的人员20:00有上线任务,别忘记了 | Apple | 19:45 | 待处理 | 本行为样例 |
执行上线前SQL脚本 | Boy | 20:00 | 待处理 | 本行为样例 |
发布提前配置好的配置中心(如携程的apollo) | Cat | 20:10 | 待处理 | 本行为样例 |
应用发布 | Dog | 20:20 | 待处理 | 本行为样例 |
执行上线前SQL脚本 | Egg | 20:30 | 待处理 | 本行为样例 |
基本功能线上验证(技术侧) | Fish | 20:40 | 待处理 | 本行为样例 |
同步通知产品同学验证 | Fish | 20:40 | 待处理 | 本行为样例 |
如上述任何步骤出现不符合预期的情况,则进行上线版本回滚(回滚步骤请务必提前准备好) | Go | 执行时补充 | 待处理 | 本行为样例 |
如发版顺利完成,在讨论组感谢各方配合的人员 | Hill | 21:00 | 待处理 | 本行为样例 |
等等 |
Tips
如上面"上线版本回滚"所说的:请务必提前准备好《上线版本回滚步骤》 。
以免陷入无法回滚的境地。
上线后需执行的工作
一般,上线完后会留有一些收尾工作,我们记录好,按照计划的时间及时跟进。
事项 | 责任人 | 时间 | 进展 | 备注 |
---|---|---|---|---|
线上观察结果确认 | Apple | 2024/12/10(发版第二天) | 待处理 | 本行为样例 |
等等 |
Tips
如果涉及跨部门协作,而该部门的配合人员对我们的任务积极配合 且发挥关键的作用 。
我们可以通过邮件等方式表达我们的感谢。
最后
小弟不才,学识有限,如有错漏,欢迎指正哈。
如果本文对你有帮助,记得"一键三连
"("点赞
"、"评论
"、"收藏
")哦!