前端项目交接规范（draft）

[hjzheng]

前端项目交接规范

交接中关心的五大问题

1. 如何进行开发？
2. 如何发布？
3. 有没有什么难点？
4. 后端谁负责？
5. 测试谁负责？

1.如何进行开发？

• 技术栈部分 (框架，库，工具，项目结构，还有开发规范，注意事项等)
  • 框架和库
    • 例如 AngularJS 1，UI-Router 和 angular-utils 具体可以参考 package.json
  • 项目结构
    • 例如 目录结构列表，每个目录存放什么代码，如下方目录结构图所示，当然可以更详细，这里只是一个例子。
  • 开发规范
    • 如果有开发规范，可以列出相关地址， 例如: AngularJS1.x + ES5 或者 AngularJS1.x + ES6
• 业务部分（产品设计文档，UX 设计原型图，部分业务讲解）
  • 产品设计文档
    • 相关地址链接
  • UX 设计原型图
    • 相关地址链接
  • 部分业务讲解
    • 可以直接联系产品经理开会沟通
• 工程化部分 （如何区分三种环境，本地如何mock，出了问题如何与QA或线上环境联调）
  • 打包
    • 例如请参考 package.json script
  • mock
    • 例如使用 json-server 进行 mock，mock方法或例子
  • 前后端联调
    • 例如通过 express 配置代理，如何配置

├── LICENSE
├── README.md
├── demos
├── dist
├── docs
├── mock
├── package.json
├── scripts                                                  工程化脚本
│   ├── build-prepare-production.sh
│   ├── build-prepare-test.sh
│   ├── build.sh
│   ├── publish-docs.sh
│   ├── publish-package.sh
│   ├── release-production.sh
│   ├── release-test.sh
│   └── release.sh
├── server.js                                                express 启动文件
├── src                                                         
│   ├── assets                                               css，图片等静态资源
│   ├── common                                               公共 utils 配置
│   ├── components                                           组件
│   └── index.js
├── test
├── webpack-build.config.js
├── webpack-common-loaders.js
├── webpack-dev.config.js
└── yarn.lock

2.如何发布？

• 系统环境 （机器，系统信息，容器，nginx 配置等）

环境	机器	账号	密码	配置信息
dev	172.17.33.222	root	*****	操作系统，服务， nginx 配置，代码部署位置等信息
qa	172.17.33.223	root	*****	如上
stage	172.19.33.222	root	*****	如上

• 发布 （QA，Dev，线上环境）
  • 发布方式: 例如如果是 jenkins，请告知方法，如果是其他方式，发布脚本或其他等信息交接。
  • 整个项目部署架构讲解，最好可以有架构图等相关信息。

3.有没有什么难点？

• 业务中最难的部分
• 技术上难点

4.后端谁负责？

• 后端负责人
• API DOC

5.测试谁负责？

• 测试负责人
• 测试用例和测试报告