用户手册(User Manual)书写规范

此博文属各人总结经验，由于项目信息保密，现以ADF操作手册为例进行整理，欢迎各位指正并丰富：

1. 尽量使用界面的上操作按钮的原图来明示操作动作。如：

2.尽可能每个步骤都配有截图，并且图片有标题和序号，且序号和步骤序号相同

 

3.所有术语，动词，用法统一

4. Note的使用：a.表单的填写规范 b. 补充说明特例情况 c.前提操作条件

    所有的Note块均需采用如下图或字体样式特殊与正文区分

 

5.每个功能模块均需有一个功能总述再开始步骤描述

 6.功能模块顺序应与需求一致，有利于提高编写手册的测试用例覆盖率和满足度

7.编写手册的模拟数据要可读性强，提高真实度

8.截图分为局部和全局，部分操作或状态变化的截图要使用局部截图，并放大加标示

 9. 凡是功能点均需列入标题类型，以便通过目录或导航窗口（Word or PDF）迅速查找

10. 多种操作情况用If开头分别进行步骤描述

11. 所有的功能描写除正流程外，还需考虑负流程及报错和处理方案。

       我所采用的编写格式如下：

 

12. 手册的字体规范定义统一，改正或忽略所有文档中的波浪线提示

 

本文出自 “叶子文文” 博客，谢绝转载！