公司团队规范研发流程概要
# 一、背景
- 背景：XXX研发部门开发流程步骤以及开发工具，依赖版本，开发规范等相关信息。
- 技术定位：All。
- 目标群体：所有相关研发部门技术人员。
# 二、操作步骤
# 2.1 开发前的准备
# 准备工作一
开发相关账号开通
❤️温馨提示：确保相应的开发账号都已经开通，并且已经授权相应所负责项目代码的下载，提交，推送权限。
- 相关账号开通咨询@XX人。
# 准备工作二
# 统一开发工具
下面所列开发工具都为当下最热门的开发工具，如果你有更好的工具也可在公司内部推行。
| 名称 | 备注说明 |
|---|---|
| IntelliJ IDEA | JAVA开发 |
| PyCharm | PYTHON开发 |
| vscode | 前端开发 |
| xshell | ssh链接工具 |
| xftp | ftp工具 |
| Navicat（可链接mongdb） | 数据库链接工具 |
| RedisDesktop | redis链接工具 |
| 元数建模 | 数据库设计工具 |
| RedisDesktop | redis链接工具 |
# 环境依赖版本要求
| 名称 | 版本 | 备注说明 |
|---|---|---|
| JDK | 1.8 | |
| python | 3.11 | |
| maven | 3.9.2 |
# 规范开发
为了公司整体研发高效，我们对于完成公司开发工作做了以下的规范和标准。
# 版本控制
我们统一使用git进行版本控制，采用AoneFlow模式。模式详情可见下面链接文档👇
Git AloneFlow模式 (opens new window)
# java开发规范
采用阿里巴巴最新java开发手册（黄山版）为XX公司的java开发的规约，希望java开发人员熟读谨记并且。手册详情可见下面链接文档👇
JAVA开发手册黄山版 (opens new window)
❤️温馨提示：文档无法查看视图大纲，可以下载到本地用pdf工具按需查看相应章节。
🙋如果记不住也没关系，可在ide开发工具上装规约扫描插件，自动扫描提交代码的规范是否达标。
插件下载地址：Alibaba Java Coding Guidelines(Fix Some Bug) (opens new window)
我们代码提交的最低标准做到Major级别，最好做到扫描全部通过。
下图为扫描示例：
- 🈲Blocker（崩溃）（一定要修改代码）：阻碍开发或测试工作的问题。
- 🈚Critical （严重）（根据情况改代码）：系统主要功能部分丧失、数据库保存调用错误、用户数据丢失。
- 🉑Major （一般）（选择性修改代码）：功能没有完全实现但是不影响使用，功能菜单存在缺陷但不会影响系统稳定性。
# 数据库设计
采用阿里云数据库设计开发规范为XX公司的数据库开发的规约，希望涉及到数据库开发设计的相关人员熟读谨记。
手册详情可见下面链接文档👇
链接：https://pan.baidu.com/s/1Cr1FBw4vw8Lizbrwe1djiQ?pwd=x4ud (opens new window)
提取码：x4ud
❤️温馨提示：文档无法查看视图大纲，可以下载到本地用pdf工具按需查看相应章节。
# 代码提交
每次提交记得务必格式化代码（当然可以统一用格式化插件做）。
❤️温馨提示：JetBrains系开发工具的代码格式化快捷键：
- Windows：Ctrl+Alt+l
- Mac：Command + Option + L
# 软件工程开发流程
# 2.2 项目启动
项目启动会文档模板 产品需求文档 需求评审文档
# 2.3 概要需求 todo
- 产品给出原型图
- ui 开发工程了解需求
- 项目经理评估开发难度给出任务拆分，任务计划，记录好里程碑信息
# 2.4 界面设计 todo
ui设计规范以及设计素材给出
# 2.5 需求设计 todo
技术评审文档模板（可去飞书文档找喜欢的文档模板）
# 2.6 研发设计 todo
概要设计（可去飞书文档找喜欢的文档模板） 通讯设计（可去飞书文档找喜欢的文档模板） 表结构设计（可去飞书文档找喜欢的文档模板）
# 2.7 开发阶段 todo
（可去飞书文档找喜欢的文档模板）
# 2.8 测试阶段 todo
准备测试用例（可去飞书文档找喜欢的文档模板） 测试结果报告（可去飞书文档找喜欢的文档模板） 压测报告（可去飞书文档找喜欢的文档模板） 用户手册（可去飞书文档找喜欢的文档模板） bug记录（可去飞书文档找喜欢的文档模板）
# 2.9 上线阶段 todo
（可去飞书文档找喜欢的文档模板）
有任何问题或建议，可向@XX人 进行反馈哦！👏