烹烹项目设计文档写法

开发文档

概述

烹烹项目设计文档能起到下面的作用：

• 以便于工程师进行代码维护
• 容易暴露项目设计的问题
• 方案设计能站在更高的层次来考虑问题
• 文档在项目开发各个角色间起到桥梁作用

文档编写原则

• 整体架构设计
• 突出重点、难点
• 根据产品不同端的特点，没有一个统一模板

不同端的设计文档

web端系统设计文档

web端系统至少有web后端

一般要包含的部分

• 系统各个模块图
• 系统存储方案设计
  
  • 缓存其他存储方案设计
• 通信协议说明
  
  • 采用json、远程调用、webservice等
• 后端提供的api地址和各字段说明

涉及到多个系统

• 各个系统架构设计

包含前端的

• 前端和后端间的架构设计

包含复杂的流程的

• 各个模块或者类的流程图、序列图

包含比较复杂的实现模块

• 说明该模块的实现原理

客户端系统设计文档

客户端系统包括安卓原生app、iOS原生app、h5开发的app

一般要包含的部分

• 各个模块架构说明

用到比较新/少见的技术

• 说明用到的技术原理等

包含比较复杂的模块

• 该模块实现的流程、原理等

使用数据本地存储的

• 说明数据存储方案，数据库表设计等