软件测试随笔-生活工作点滴

XX产品使用手册

2019-07-09  本文已影响11人  涅槃Ls

歪打正着的就开始了编写“XX产品使用手册”。修改了4版吧,每一次都被大佬指点出各类问题。
现暂时总结经验如下,如简要说明不是很专业的 产品使用手册模板

经历了4次改版,总结经验如下.png

下例中会简要说明模板内容,仅作参考。后续会更新出更完善的 XX产品使用手册。

1. 产品介绍

1.1. 产品概述

XX是XX,覆盖了……。

ps.
简要说明该产品的主要模块和模块功能。

1.2. 相关概念

ps.
贴出该产品中的相关概念。

2. 快速入门

ps.
1、最好使用 word中提供的SmartArt画出基本流程。
2、让用户在尽可能短的时间内知道最简单的接入流程,若有图,用户会过早的关注细节里,不会更快的知道接入流程。

3. 产品功能

3.1. 架构图

ps.
架构图:逻辑要清晰、简洁

3.2. 功能列表

主模块 子模块 功能点
- - -
- - -

3.3. 功能说明

图文并茂,分别说明刚才的功能列表

4. 常见场景示例

ps.
常用场景示例:添加1-2个用户使用场景的简单介绍
上一篇 下一篇

猜你喜欢

热点阅读