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

简介:

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

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

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

 

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

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

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

 

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

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

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

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

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

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

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

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

 

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

本文转自叶子文文博客51CTO博客,原文链接http://blog.51cto.com/leafwf/1070756如需转载请自行联系原作者


叶子文文

相关文章
|
开发工具 git
【Ant Design Pro】使用ant design pro做为你的开发模板(五)去除无效代码,生成一个清晰的开发模板
【Ant Design Pro】使用ant design pro做为你的开发模板(五)去除无效代码,生成一个清晰的开发模板
542 0
【Ant Design Pro】使用ant design pro做为你的开发模板(五)去除无效代码,生成一个清晰的开发模板
|
4月前
|
存储 安全 Java
java标识符命名规范--代码格式规范--注释规范--最佳实践和禁忌--代码示例
java标识符命名规范--代码格式规范--注释规范--最佳实践和禁忌--代码示例
130 0
|
11月前
|
Java Apache
超实用!教你如何在POI-TL框架中熟练使用Configure类,快速完成Office文档生成!
POI-TL是一个用于生成Office文档的Java库,Configure类是该库中的一个配置类,其作用是提供了一些全局的配置选项,可以用于定制化生成的文档。
250 0
|
搜索推荐 JavaScript 前端开发
python接口自动化(十八)--重定向(Location)(详解)
在实际工作中,有些接口请求完以后会重定向到别的url,而你却需要重定向前的url。URL主要是针对虚拟空间而言,因为不是自己独立管理的服务器,所以无法正常进行常规的操作。但是自己又不希望通过主域名的二级目录进行访问,而 是希望通过主域名的二级域名进行访问。所以这个时候就会用到URL重定向。
179 0
python接口自动化(十八)--重定向(Location)(详解)
|
jenkins 持续交付 Python
python接口自动化(十四)--session关联接口(详解)
上一篇cookie绕过验证码模拟登录博客园,但这只是第一步,一般登录后,还会有其它的操作,如发帖,评论等等,这时候如何保持会话呢?这里我以jenkins平台为例,给小伙伴们在沙场演练一下。
187 0
python接口自动化(十四)--session关联接口(详解)
|
jenkins 持续交付 Python
python接口自动化(十五)--参数关联接口(详解)
我们用自动化新建任务之后,要想接着对这个新建任务操作,那就需要用参数关联了,新建任务之后会有一个任务的Jenkins-Crumb,获取到这个Jenkins-Crumb,就可以通过传这个任务Jenkins-Crumb继续操作这个新建的任务。
431 0
python接口自动化(十五)--参数关联接口(详解)
|
测试技术
Cypress系列(9)- Cypress 编写和组织测试用例篇 之 .skip() 和 .only() 的详细使用
Cypress系列(9)- Cypress 编写和组织测试用例篇 之 .skip() 和 .only() 的详细使用
146 0
Cypress系列(9)- Cypress 编写和组织测试用例篇 之 .skip() 和 .only() 的详细使用
|
Ruby
《Cucumber:行为驱动开发指南》——2.3 创建步骤定义
现在在fetures/step_definitions目录下创建一个名为calculator_steps.rb的文件,只要这是一个Ruby文件,Cucumber并不介意你给这个文件起什么名字,但这里我们给这个文件起的名字其实不错。
2346 0
SAP Spartacus源代码里declare关键字的含义
SAP Spartacus源代码里declare关键字的含义
71 0
SAP Spartacus源代码里declare关键字的含义
|
Java Android开发
如何实现SAP GUI的自定义语法检查(Syntax check)
如何实现SAP GUI的自定义语法检查(Syntax check)
212 0
如何实现SAP GUI的自定义语法检查(Syntax check)