开发日常规范细则

一、新人入职操作细则：

1.入职相关流程（OA、LDAP、VPN等）及基础开发工具配置（jdk、maven、IDEA、）；【第一天】
2.5.入职学习、6.常见中间件及工具地址；【第一天】
3.01.开发及上线流程、03.数据库设计文档规范、04.代码规范篇、05.日志规范；【第二天】
4.熟悉业务和数据库设计文档04-业务系统、sdb-cms数据库表结构；【第三天】
5.开发流程规范（如何接需求、如何创建issue、如何确定排期、如何与相关配合同学沟通、如何上线）；【第三天】
6.接小需求或者SEA后台展示类需求；
7.步入正轨，根据不同需求讲解不同业务逻辑，变接需求边了解整体业务；
8.值班相关内容：值班问题总结；

注：
1.数据库设计规范、代码规范必须强制制定，没有商量的余地；
2.当写代码的过程中感觉流程或者数据库表使用有问题的时候一定要注意，
当你出现这个感觉的时候一定要与其他人或组长沟通一下，证明对需求
没有了解透彻或者需求设计有问题；

二、日常需求开发细则：

需求设计

1.需求设计文档：
需求设计完成需要包含内容：
①.功能点梳理；
②.数据库设计文档；
③.数据库设计UML图；
④.业务流程图及逻辑流程图；
⑤.接口文档；
注意：
①.数据库设计要写入对应的数据库设计WIKI目录下，不要把数据库设计直接写入到需求设计文档中,需求设计关联数据库设计链接；
②.接口文档写入到YAPI中，不要写入到需求设计文档中,需求设计关联YAPI链接；
③.数据库设计中要包含索引的创建；
④.数据库设计要与组长做评审，评审过程中要对字段的命名、类型、长度、索引做讨论；
⑤.需求设计要具有前瞻性，但不可过于复杂，目前阶段业务还在高速发展；（不可过渡设计！！！）

示例：
需求设计：
6.需求设计
01.需求设计模板
数据库设计：
03.数据库设计文档规范
sdb-cms数据库表结构

2.调研文档：
①.调研文档中要包含本项目中使用到的第三方所有接口及关联文档地址；
②.有逻辑流程的，要在调研文档中简述相关流程或调用顺序；如果逻辑流程与业务耦合性较高也可在需求设计文档中给出；
③.有特殊注意事项的细节要在调研文档中显著标明，例如第三方接口的限制或调用频次；
注：
项目是否需要外部第三方介入决定了是否创建调研文档，外部第三方指微信、企微、有机云、电销第三方等；
示例：
02.需求设计下调研文档

3.排期文档：
排期文档中要包含以下几项：
①.项目目前状态；
②.项目当前整体进度；
③.项目各个部门进度，例如开发进度、联调进度、测试进度等；
④.项目整体排期表；
⑤.项目各功能模块或者功能点排期明细，明细中排期要具体到每一个接口；
注：
①.排期明细中要指出各个功能点的参与人、开发时间、开发进度、联调时间、联调进度、
测试时间、测试进度、分功能模块提测的要给出功能模块提测时间；
②.有接口提测的要给出接口提测时间；
③.时间排期,同产品、前端、QA共同确定后给出；
④.联调时间，提测时间与前端确认后给出，上线时间QA给出；
示例：
02.需求设计下排期文档

4.提测文档：
提测文档：
7.提测文档、03.需求设计下提测文档模板

5.上线计划：
上线计划中要包含以下几项内容：
①.账号信息、基础依赖信息；
②.数据库表结构创建脚本；
③.数据库初始化数据脚本；
④.老表数据修改或者索引修改脚本；
⑤.Apollo配置，配置项中需标明新增还是删除，对于包含多个项目
的要在配置项中标明是相关配置归属哪个项目；
⑥.分支内容，分支内容中要包含序号、项目、开发分支、上线分支、
上线版本（normal-tag、pre-tag）、回滚版本、对于多人合作项目要标明打包人；
注：
①.上线计划要在开发过程中边开发边维护，而不是上线前总结；
②.生成表结构创建或者修改脚本后要先去archer做验证；
③.所有Apollo配置项在代码中一定要有默认值，默认值的选择要具有健壮性，不然在Apollo挂掉后会影响主程序执行和启动；
④.回滚版本的确定一定要与上一个版本的打包人沟通后给出；

示例：
04.需求设计下上线计划模板

日常开发及上线

1.需求评审：
①.组长要在需求详细评审前确定组内开发同学，并且在与产品、前端、QA做需求详细评审时拉着对应的开发同学一起参与，
让具体开发同学详细了解需求内容和需求目标；
②.相关接口排期的确定要让组内具体开发同学给出，组长只干预最终的结果;

2.开发阶段：
①.数据库设计给出后就可根据表结构设计给出接口文档，接口文档必须存放于YAPI中；
②.内部Feign接口，MQ事件等都必须创建相应的YAPI文档或WIKI文档（存放于YAPI还是WIKI待商榷）；
④.代码开发过程按照需求设计中相关逻辑流程进行；
⑤.REST接口要有Postman或者swagger自测记录；Feign接口，MQ监听等要有内部单元测试；
⑥.提测前要保证相关页面和功能的可用性，联调结果要自己确认，不是接口甩给前端就完事；

3.上线：
①.上线代码必须要进行review；
②.上线后跟踪对应项目日志至少30分钟，保证上线项目对现有业务的影响范围评估；

4.问题处理：
①.日常开发过程中遇到问题积极主动响应，主动了解情况，决绝踢皮球；
②.后端开发是一个整体,遇到问题不是你负责范围内的时候，要带着提出问题的人找到负责解决的人并描述清楚相关问题始末；
③.自己负责开发的需求,全链路自己要清晰明确,并且主动推进让需求相关的人也都清晰明确；
④.日常值班过程中要积极主动响应，日常重复性问题要推动产品出功能上线，不能功能实现的要记录于WIKI文档中值班问题总结；

5.日常提升：
①.做好技术分享和功能分享，组内相关大需求或者大功能上线要定期进行部门内部分享，也可拉着前端或者QA；
②.新人进入后迅速了解组内数据库表设计及相关业务逻辑，新人不单单包括后端开发，还包括前端及QA；

三、TODO:

1.是否强制推进sourceTree的落地，发现多次代码未推送远程的情况；
2.