阅读《基于Python语言的软件测试技术》_打开新的知识大门_2.3.4. 编写用户手册

【摘要】 本书摘自《基于Python语言的软件测试技术》一书中第2章，第3节，由张民编著。

2.3.4. 编写用户手册

用户手册是用户文档中最重要的一部分，没有用户手册的软件不能算是一个好 产品。用户手册的功能是：详细描述软件的功能、性能和用户界面，使用户了解到如何使用该软件。用户手册内容应包括功能介绍、帮助、操作步骤、操作技巧及使 用注意事项等。用户手册根据功能大致可以分为四个部分。

(1)引言：引言主要介绍了编写目的、参考资料和术语、缩写词。

(2)软件概述：主要介绍软件的用途。包括软件的输入、处理、输出，软件的 功能、结构、系统的配置和软件功能的基本原理等。

(3)软件使用过程：主要介绍如何安装系统、如何运行系统、运行步骤、运行 说明等。

(4)软件维护过程：主要介绍系统遇到问题如何解决、专用维护程序等。

用户手册与操作手册最大的区别是，用户手册不光要对系统操作进行说明，还 要介绍服务器配置、系统安装、系统操作、系统维护等，完全是套成熟的流程模 式。用户通过阅读用户手册，可以对产品的功能、操作有一定的认识；按照用户手 册上的说明，通过实际操作，能够掌握产品的操作方法及解决过程中出现的各种问题。

5.自动的一致性分析

一致性包含两种含义： 一是事物与标准的一致性，指的是事物是否符合标准。 保持事物与标准的一致性的重要性在于减少后期由于项目人员理解不同带来的不必 要的浪费。二是标准之间的一致性，指的是规范同一 目标的标准，相互之间不应有 矛盾或不一致，否则在标准执行过程中必然会发生混乱。在国际标准化工作中，对 于形成系统的标准体系和标准群集，进行一致性的研究和一致性的测试与评价，已 经成为一项常规的、必做的工作。标准之间的一致性特指基础标准与其专用标准 之间的一致性，其重要意义就在于：通过保持基础标准与其专用标准之间的一致 性，确保了跨行业或领域的数据集成、共享和互操作，从而提高了经济效益和社会 效益。

一致性测试的必要性：标准文本基本是使用自然语言描述的，存在很大的二义 性和模糊性，实现者对于标准的不同理解会导致不同的标准实现。

(1)叙述过于简单或者复杂得难以理解；

(2)例外处理没有进行定义；

(3)标准本身存在矛盾或错误等；

(4)实现者对于标准理解不同。

自动的一致性分析就是通过建立一套专用的标准，进行软件一致性测试，通过 保持标准的一致性和自然语言描述的一致性，从而在一定程度上降低不同理解带来 的时间冗余，减少人力资源和经济成本，同时也为后期的系统维护带来便利，避免 不一致性带来不可避免的错误。

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们 [email protected] 处理，核实后本网站将在24小时内删除侵权内容。