基础文档说明模板

本文章转载于搜狗测试

前言

作为一名测试人员，要想全面了解一个模块，需要关注需求文档、测试用例、测试方法、已知bug等等。这么多信息，当你需要交接模块的时候，是打包一堆文档吗？还是不间断的给接收人说明：xxx文档在哪里、xx应该怎么测试……

oh no…,你只需要一份基础文档说明就行，模板如下，拿走不谢~~~

需要电子模板的，文末留下邮箱~~

模板说明

XXX模块基础文档

1文档修改记录

1.1更新日志

2功能介绍

2.1功能简介（使用精简语言或者图示对该功能进行说明）

例如：安装包管理：管理存储在sd卡中.apk格式安装包，方便用户进行清理或安装

3需求文档说明

3.1需求文档（模块对应需求文档的详细路径）

3.2设计文档（模块对应设计稿的详细路径）

4测试执行说明

4.1执行用例路径（模块对应各类型用例的详细路径）

1.详细功能用例

2.基础文档库

3.Checklist

4.入口用例

5.兼容性用例

6.评测用例

7.Pingback用例

4.2 测试方法介绍说明

1.接口说明（该功能涉及的接口信息说明，比如：接口名称、url、字段信息、请求时机）

2.测试环境（如何搭建测试环境；测试数据存放路径；某功能的触发步骤）

a)导出本地数据库的方法：xxxx

b)模拟数据升级的方法：xxx

c)测试需要的数据内容：xxxx

3.测试说明(不需要测试关注说明；测试重点的内容，测试方法说明)：

a．数据库升级完毕后，需要关注数据库版本号是否改变，未变不生效

b．如何添加标签：客户端XXX请求返回的XXX字段，修改应用中tags字段

4.   名词解释（测试用例中某些专有名词，其他模块没有的，在这里说明）：

例如：内存白名单：解释说明xxxx

缓存白名单：解释说明xxxx

5常见问题

5.1历史上线问题（将历史上线问题整理成用例的形式罗列在下面，备忘）

1.弹出升级通知，使用kill命令杀掉大精品classic的进程，点击大精品的通知，检查能够发送点击通知的pingback

5.2容易出问题的测试场景（罗列平时测试过程中经常出现问题的场景或步骤，备忘）

例如：

1.上线前开发打的release包，需要需要检查无log输出

5.3兼容性常见问题（UI兼容，开发建议的功能兼容性，接口兼容性等）

例如：

1.2.0版本XX接口升级（增加新请求参数xx或者返回参数xx）后，对应不同的客户端版本1.0和2.0均能返回数据

2.华为emui3.0系统，通知条和悬浮窗、自启动默认都是关闭，首次安装程序后，检查以上功能是否正常可用

3.(872715) :一键装机的“连接wifi”提示在480P显示折行（已与产品沟通，进行文案缩减）

6模块关联性（与该模块有关联的功能说明）

7相关技术说明（模块测试需要用到的技术说明）

例如：

1.升级使用的是adb install –r命令进行的覆盖安装。安装新的带锁屏功能的助手APK时，需要卸载之前安装的独立锁屏程序，否则会提示应用供应商冲突