【写在前面：为什么整理这个，因为我们很多开发写的技术文档真的是，，，所以希望日后随手提供开发一个自己需要的文档格式，培养写技术文档的能力，增进合作效率】
一、需求背景
1、需求文档链接
2、简要说明业务背景
3、需求范围（明确此次需求涉及的模块等）
二、流程图
1、技术角度流程图
三、数据库
1、表结构设计
2、表关联关系说明
四、接口概览
1、接口描述（请求入口截图或者别的）
2、接口链接（URL）
3、请求方式
4、请求参数
5、请求参数示例（格式）
6、返回数据
7、返回数据示例（格式）
8、接口间关联关系
9、数据字典：例如参数值是数字的，在这一部分说明数字对应什么
10、返回值code码说明
五、测试帮助文档
1、增删改查接口（附带入参&返回等）
2、测试方法（有影响线上展示的情况提供）
3、影响范围
——————————————————————————————————————————
20200217补充:
六、公共细节提醒
1、系统核心设计点
2、系统调用依赖（上下游&对接人）
3、本次迭代对现有系统影响
4、测试分析（重点、容易遗漏的测试点）
——————————————————————————————————————————
20200327补充：
七、其他说明
1、ABtest
2、版本兼容（兼容历史版本）
3、术语解释（需求新起的名称做说明，避免太多种名称）
八、FAQ
九、附录
网友评论