软件文档写作15用户文档课件.ppt

《软件文档写作15用户文档课件.ppt》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、8.3用户手册软件的质量是由多个方面构成的，用户手册也是衡量软件质量的一个重要标准。特别是目前软件需求快速增长，市场迅速扩张的时期，不少软件开发者过于注重软件的功能、性能，而忽略了软件作为产品的其它方面的质量，而用户手册的质量问题尤为突出。一个优秀的用户手册可以帮助用户快速入门，是用户正确、充分使用软件的前提。对于开发者来说，质量符合要求的用户手册，至少可以减少用户培训和售后服务的投入。所以，对软件开发者来说，应该充分认识软件产品用户手册的重要性，提高用户手册的质量，以促进软件产品质量的整体提高。一份质量良好的软件产品用户手册应该满足以下几点重要方面:11.用

2、户手册的完整性在实际使用中经常发现，很多软件由于开发过于仓促，在付诸使用时，用户手册中经常缺少关于某些方面的说明，有时缺少的还是十分重要的内容，让用户使用时，感到困难，甚至是无所适从。而质量良好的用户手册，至少应该是能够包括软件产品的所有相关内容，能够指导用户顺利的安装、设置和使用软件。因此，保证内容的全面性和完整性是把握用户手册质量的重要方面。2.用户手册的描述与软件实际功能的一致性用户手册的内容不仅要保证其全面性和完整性，还要确保它与一起发行的软件版本的实际功能相一致。现实情况是，由于开发企业产品研发管理和产品版本管理方面存在的问题，产生用户手册描述内容和

3、软件实际运行情况不一致，造成用户使用中的困惑和误解，进而影响软件的正常使用。23.用户手册的易理解性由于软件产品的用户往往对计算机方面的专业知识了解不多，对软件运行缺少实际的脑际映像，因此，用户手册的可理解性，是其质量的重要指标。对于软件使用中那些关键的、重要的、文字难表述清楚的，或者使用图表方法可以简化描述，增加可理解性的内容，应该采用图表或附有图表的方式描述。优秀的用户手册应该是图文并举，易读、易理解、易对照。4.用户手册应提供学习操作的实例一个没有软件运行和操作实例的用户手册，对于用户来说，其实并没有太大的帮助。例如，软件中关于系统网络参数配置的说明，如

4、果没有具体实例的辅助演示，相信绝大多数没有多少网络知识的用户是很难胜任的。一个优秀的用户手册，不仅要对软件主要功能和关键操作提供应用实例，而且实例的描述还应做到详细、充分，易于理解，实例最好由图示的方法描述。35.用户手册的印刷与包装质量用户手册作为商品化软件产品的重要组成内容，其纸张、印刷、装订、包装等的质量，包括版面、封面等的设计质量，手册和软件应用类型的吻合程度等，都将直接影响软件的形象、市场可接受度和最终的销售业绩。另外，用户手册不同于用户使用说明书，它除了向用户提供基本的产品操作方法，还要提供很多与产品相关的其它信息。主要包括以下方面：-介绍：软件的

5、基本情况-用途：介绍软件的适用范围、功能、性能主要及其特点-运行环境：介绍软件最基本的和推荐的运行配置、软件安装说明、参数设定等，以及可能引起的和系统的冲突，解决途径等-使用过程：向用户介绍软件具体的使用方法-相关信息：必要的开发者信息，软件注册、升级途径等48.4操作手册操作手册是指导软件具体操作的工具书。操作手册涉及软件设计完成后的以后所关心的有关操作的内容。由于操作的项目不同，操作手册的内容和形式也有所不同。在形式上，有技术指导书，也有操作规程等类型。内容上，伸缩的余地较大。但一般而言，操作手册的内容主要应包括：1.引言。主要简介软件的外围特性、软件名称

6、、开发单位、专用名称，概述软件内部的一些结构，介绍手册涉及的技术、设备或产品的特点、用途、使用对象、指导的内容，以及手册的编排格式等，一些规模较大的手册，还要介绍手册的使用方法和检索示例，使读者对手册和软件产品都有一个大概的了解。写作上，要求简明扼要，叙述全面、真实，读者读后能感受到对手册和软件产品的一个提纲式的了解。52.操作原理。这部分内容是对操作对象或过程的主要性质或步骤的解释，为操作者提供理论依据和操作基础。这部分内容要求适合操作者的专业水平，一般不宜过于专深，内容描述可结合公式、框图、图表等，要求易于阅读、理解。3.操作说明。介绍操作的具体步骤和要求

7、，是操作手册的核心部分。步骤的组织结构一般按每一步骤分点说明。操作说明的辅助叙述方法主要有图解、框图、程序、表格等。这些辅助表述方法有时也会成为手册内容的主要表述形式。如操作过程的说明。操作说明要求简练、准确、形象、清晰、易懂，表述内容应与系统实际操作过程对应一致，语句多采用短句和主动语态，经常是一个动作、一个步骤为一个编号单位。64.注意事项。注意事项是指系统操作过程中应该注意的内容。注意事项和故障排除也经常放在操作说明中。但更多的时候，为了强调，将其单独列出，还有那些不属于基本操作的内容，也可放在这一部分。如软件与运行环境的维护、保管、技术故障的判断、排除

8、、操作质量的分析等。5.附录。主要用于