项目设计文档结构.md

标题

// 1. 文档标题使用 一级标签 #

// 2. 使用表格列举文档维护时间

时间	版本	内容	修改人
2019/10/20	1.0.0	首次编写

// 3. 使用Markdown语法生成简易目录

[TOC]

// 4. 使用二级标签 ## 列举需求要求

注：章节内部如何划分请自主选择、但务必简洁清晰、表述准确。

例：

需求

需求概述

需求文档位置

项目版本

修改范围

设计

概述

// 注：可以此处简明扼要的表述设计的原理和相关概念等。

设计思想

// 注：请在此章节阐述设计的思想或使用的设计模式、原理等

设计内容

// 注：以下是设计文档的正文，也是设计文档的核心。根据各自设计文档的内容进行划分具体章节进行描述即可

设计正文部分遵循以下规则：

• 复杂的业务或使用章节 可以插入少量代码示例。
• 复杂的流程需按步骤进行讲解。

特殊场景处理

// 5. 特殊场景处理 在做设计时需要考虑以下情况并做好相应正确处理

注：特殊场景列举了 设计中必须要要考虑的项目中一些特殊场景如：

App端

正常业务场景

• 受模块管控
• 切换环境
• push推送

网络环境处理

• WiFi 和 移动网络切换
• 无网络处理
• 网络请求超时

.....

参考

// 6. 参考章节 列举在做设计过程中参考的 文档、blog、或者相关设计 等在此处列举可以方便后续查找。