《软件文档写作15-用户文档2.ppt》由会员分享，可在线阅读，更多相关《软件文档写作15-用户文档2.ppt（17页珍藏版）》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。
1、8.3 8.3 用户手册用户手册 软软件件的的质质量量是是由由多多个个方方面面构构成成的的，用用户户手手册册也也是是衡衡量量软软件件质质量量的的一一个个重重要要标标准准。特特别别是是目目前前软软件件需需求求快快速速增增长长，市市场场迅迅速速扩扩张张的的时时期期，不不少少软软件件开开发发者者过过于于注注重重软软件件的的功功能能、性性能能，而而忽忽略略了了软软件件作作为为产产品品的的其其它它方方面面的的质质量量，而而用用户户手手册册的的质质量量问问题尤为突出。题尤为突出。一一个个优优秀秀的的用用户户手手册册可可以以帮帮助助用用户户快快速速入入门门，是是用用户户正正确确、充分使用软件的前提。充分使用
2、软件的前提。对对于于开开发发者者来来说说，质质量量符符合合要要求求的的用用户户手手册册，至至少少可可以以减减少用户培训和售后服务的投入。少用户培训和售后服务的投入。所所以以，对对软软件件开开发发者者来来说说，应应该该充充分分认认识识软软件件产产品品用用户户手手册册的的重重要要性性，提提高高用用户户手手册册的的质质量量，以以促促进进软软件件产产品品质质量量的的整整体提高。体提高。一一份份质质量量良良好好的的软软件件产产品品用用户户手手册册应应该该满满足足以以下下几几点点重重要要方面方面:11.1.用户手册的完整性用户手册的完整性 在在实实际际使使用用中中经经常常发发现现，很很多多软软件件由由于于
3、开开发发过过于于仓仓促促，在在付付诸诸使使用用时时，用用户户手手册册中中经经常常缺缺少少关关于于某某些些方方面面的的说说明明，有有时时缺缺少少的的还还是是十十分分重重要要的的内内容容，让让用用户户使使用用时时，感感到到困困难难，甚甚至至是是无无所所适适从从。而而质质量量良良好好的的用用户户手手册册，至至少少应应该该是是能能够够包包括括软软件件产产品品的的所所有有相相关关内内容容，能能够够指指导导用用户户顺顺利利的的安安装装、设设置置和和使使用软件。用软件。因因此此，保保证证内内容容的的全全面面性性和和完完整整性性是是把把握握用用户户手手册册质质量量的的重要方面。重要方面。2.2.用户手册的描述
4、与软件实际功能的一致性用户手册的描述与软件实际功能的一致性 用用户户手手册册的的内内容容不不仅仅要要保保证证其其全全面面性性和和完完整整性性，还还要要确确保保它与一起发行的软件版本的实际功能相一致。它与一起发行的软件版本的实际功能相一致。现现实实情情况况是是，由由于于开开发发企企业业产产品品研研发发管管理理和和产产品品版版本本管管理理方方面面存存在在的的问问题题，产产生生用用户户手手册册描描述述内内容容和和软软件件实实际际运运行行情情况况不不一一致致，造造成成用用户户使使用用中中的的困困惑惑和和误误解解，进进而而影影响响软软件件的的正正常常使用。使用。23.3.用户手册的易理解性用户手册的易理
5、解性 由由于于软软件件产产品品的的用用户户往往往往对对计计算算机机方方面面的的专专业业知知识识了了解解不不多多，对对软软件件运运行行缺缺少少实实际际的的脑脑际际映映像像，因因此此，用用户户手手册册的的可可理理解解性性，是其质量的重要指标。是其质量的重要指标。对对于于软软件件使使用用中中那那些些关关键键的的、重重要要的的、文文字字难难表表述述清清楚楚的的，或或者者使使用用图图表表方方法法可可以以简简化化描描述述，增增加加可可理理解解性性的的内内容容，应应该该采采用图表或附有图表的方式描述。用图表或附有图表的方式描述。优秀的用户手册应该是图文并举，易读、易理解、易对照。优秀的用户手册应该是图文并举
6、，易读、易理解、易对照。4.4.用户手册应提供学习操作的实例用户手册应提供学习操作的实例 一一个个没没有有软软件件运运行行和和操操作作实实例例的的用用户户手手册册，对对于于用用户户来来说说，其其实实并并没没有有太太大大的的帮帮助助。例例如如，软软件件中中关关于于系系统统网网络络参参数数配配置置的的说说明明，如如果果没没有有具具体体实实例例的的辅辅助助演演示示，相相信信绝绝大大多多数数没没有有多多少少网网络知识的用户是很难胜任的。络知识的用户是很难胜任的。一一个个优优秀秀的的用用户户手手册册，不不仅仅要要对对软软件件主主要要功功能能和和关关键键操操作作提提供供应应用用实实例例，而而且且实实例例的
7、的描描述述还还应应做做到到详详细细、充充分分，易易于于理理解解，实例最好由图示的方法描述。实例最好由图示的方法描述。35.5.用户手册的印刷与包装质量用户手册的印刷与包装质量 用用户户手手册册作作为为商商品品化化软软件件产产品品的的重重要要组组成成内内容容，其其纸纸张张、印印刷刷、装装订订、包包装装等等的的质质量量，包包括括版版面面、封封面面等等的的设设计计质质量量，手手册册和和软软件件应应用用类类型型的的吻吻合合程程度度等等，都都将将直直接接影影响响软软件件的的形形象象、市市场场可接受度和最终的销售业绩。可接受度和最终的销售业绩。另另外外，用用户户手手册册不不同同于于用用户户使使用用说说明明
8、书书，它它除除了了向向用用户户提提供供基基本本的的产产品品操操作作方方法法，还还要要提提供供很很多多与与产产品品相相关关的的其其它它信信息息。主主要包括以下方面：要包括以下方面：-介绍介绍：软件的基本情况：软件的基本情况-用途用途：介绍软件的适用范围、功能、性能主要及其特点：介绍软件的适用范围、功能、性能主要及其特点-运运行行环环境境：介介绍绍软软件件最最基基本本的的和和推推荐荐的的运运行行配配置置、软软件件安安装装说说明、参数设定等，以及可能引起的和系统的冲突，解决途径等明、参数设定等，以及可能引起的和系统的冲突，解决途径等-使用过程使用过程：向用户介绍软件具体的使用方法：向用户介绍软件具体
9、的使用方法-相关信息相关信息：必要的开发者信息，软件注册、升级途径等：必要的开发者信息，软件注册、升级途径等48.4 8.4 操作手册操作手册 操操作作手手册册是是指指导导软软件件具具体体操操作作的的工工具具书书。操操作作手手册册涉涉及及软软件设计完成后的以后所关心的有关操作的内容。件设计完成后的以后所关心的有关操作的内容。由由于于操操作作的的项项目目不不同同，操操作作手手册册的的内内容容和和形形式式也也有有所所不不同同。在在形形式式上上，有有技技术术指指导导书书，也也有有操操作作规规程程等等类类型型。内内容容上上，伸伸缩的余地较大。但一般而言，操作手册的内容主要应包括：缩的余地较大。但一般而
10、言，操作手册的内容主要应包括：1.1.引引言言。主主要要简简介介软软件件的的外外围围特特性性、软软件件名名称称、开开发发单单位位、专专用用名名称称，概概述述软软件件内内部部的的一一些些结结构构，介介绍绍手手册册涉涉及及的的技技术术、设设备备或或产产品品的的特特点点、用用途途、使使用用对对象象、指指导导的的内内容容，以以及及手手册册的的编编排排格格式式等等，一一些些规规模模较较大大的的手手册册，还还要要介介绍绍手手册册的的使使用用方方法法和检索示例，使读者对手册和软件产品都有一个大概的了解。和检索示例，使读者对手册和软件产品都有一个大概的了解。写写作作上上，要要求求简简明明扼扼要要，叙叙述述全全
11、面面、真真实实，读读者者读读后后能能感感受到对手册和软件产品的一个提纲式的了解。受到对手册和软件产品的一个提纲式的了解。52.2.操操作作原原理理。这这部部分分内内容容是是对对操操作作对对象象或或过过程程的的主主要要性性质质或或步步骤的解释，为操作者提供理论依据和操作基础。骤的解释，为操作者提供理论依据和操作基础。这这部部分分内内容容要要求求适适合合操操作作者者的的专专业业水水平平，一一般般不不宜宜过过于于专专深深，内内容容描描述述可可结结合合公公式式、框框图图、图图表表等等，要要求求易易于于阅阅读读、理理解。解。3.3.操操作作说说明明。介介绍绍操操作作的的具具体体步步骤骤和和要要求求，是是
12、操操作作手手册册的的核核心心部分。部分。步步骤骤的的组组织织结结构构一一般般按按每每一一步步骤骤分分点点说说明明。操操作作说说明明的的辅辅助助叙叙述述方方法法主主要要有有图图解解、框框图图、程程序序、表表格格等等。这这些些辅辅助助表表述述方方法法有有时时也也会会成成为为手手册册内内容容的的主主要要表表述述形形式式。如如操操作作过过程程的的说说明。明。操操作作说说明明要要求求简简练练、准准确确、形形象象、清清晰晰、易易懂懂，表表述述内内容容应应与与系系统统实实际际操操作作过过程程对对应应一一致致，语语句句多多采采用用短短句句和和主主动动语语态态，经常是一个动作、一个步骤为一个编号单位。经常是一个
13、动作、一个步骤为一个编号单位。64.4.注注意意事事项项。注注意意事事项项是是指指系系统统操操作作过过程程中中应应该该注注意意的的内内容容。注意事项和故障排除也经常放在操作说明中。注意事项和故障排除也经常放在操作说明中。但但更更多多的的时时候候，为为了了强强调调，将将其其单单独独列列出出，还还有有那那些些不不属属于于基基本本操操作作的的内内容容，也也可可放放在在这这一一部部分分。如如软软件件与与运运行行环环境境的的维护、保管、技术故障的判断、排除、操作质量的分析等。维护、保管、技术故障的判断、排除、操作质量的分析等。5.5.附附录录。主主要要用用于于非非操操作作说说明明内内容容的的补补充充叙叙
14、述述。如如运运行行环环境境的的配配套套设设备备、技技术术指指标标的的误误差差范范围围、非非常常规规过过程程部部分分和和远远程程操操作作部分等，以及在其它方面的应用或其典型操作的示例等。部分等，以及在其它方面的应用或其典型操作的示例等。附附录录也也经经常常提提供供一一些些与与软软件件产产品品密密切切相相关关的的理理论论、技技术术、方方法法、工工具具、资资料料、数数据据及及其其发发明明、创创作作或或提提供供者者的的出出处处、来来源、介绍等资料，包括技术文档、资料的引用列表等。源、介绍等资料，包括技术文档、资料的引用列表等。78.5 8.5 维护修改文档维护修改文档 根根据据软软件件生生命命周周期期
15、的的阶阶段段理理论论，软软件件投投入入运运行行后后，在在相相当当长长的的时时间间里里，由由于于业业务务、政政策策、市市场场、法法规规、管管理理、技技术术等等方方面面的的发发展展和和变变化化，都都会会使使得得软软件件应应用用机机构构的的业业务务经经历历着着持持续续不不断断的的变变化化，这这些些变变化化或或者者产产生生了了新新的的需需求求，或或者者需需要要修修改改原原先先的的软软件件需需求求。再再好好的的软软件件系系统统，都都会会随随着着系系统统应应用用领领域域业业务务的的变变化化而而变变化化。因因此此，软软件件在在其其生生命命周周期期中中是是会会不不断断的的进进行行着着维维护修改工作的。护修改工
16、作的。1.1.软件运行系统的结构软件运行系统的结构 对对运运行行中中的的软软件件进进行行维维护护修修改改，将将涉涉及及技技术术和和社社会会的的双双重重因因素素。这这不不仅仅是是由由客客观观的的工工程程准准则则决决定定，还还会会受受到到软软件件运运行行环环境和机构策略的影响。境和机构策略的影响。如如图图，软软件件运运行行系系统统的的不不同同逻逻辑辑部部分分，会会产产生生各各自自不不同同的的相互影响。相互影响。8支持软件支持软件应用软件应用软件业务策略和规则业务策略和规则硬件系统硬件系统应用数据应用数据业务过程业务过程使用使用使用使用使用使用约束约束嵌入知识嵌入知识运行在运行在运行在运行在软件运行
17、系统的例子：软件运行系统的例子：图中，各部分的含义如下：图中，各部分的含义如下：-硬件系统硬件系统：当时的硬件系统现在可能已过时，或者维护费用过高：当时的硬件系统现在可能已过时，或者维护费用过高-支支持持软软件件：系系统统运运行行所所依依赖赖的的操操作作系系统统、数数据据库库系系统统、与与硬硬件件相相关关的的实实用用程序、驱动程序、编译系统等，现在可能已无法得到生产厂家的支持程序、驱动程序、编译系统等，现在可能已无法得到生产厂家的支持-应应用用软软件件：应应用用系系统统是是由由多多个个程程序序组组成成的的，并并且且这这些些程程序序是是独独立立的的，在在不不同的时段开发的同的时段开发的-应应用用
18、数数据据：在在系系统统以以往往的的运运行行历历史史中中，积积累累了了大大量量的的数数据据，不不同同文文档档的的数数据可能不一致或有重复据可能不一致或有重复-业业务务过过程程：业业务务过过程程受受到到业业务务策策略略和和规规则则的的约约束束，对对应应用用软软件件提提出出具具体体的的需求需求-业务策略和规则业务策略和规则：规定了业务执行的规则和流程：规定了业务执行的规则和流程9 上上面面软软件件运运行行系系统统的的示示意意图图可可以以进进一一步步抽抽象象为右图所示的层次结构。为右图所示的层次结构。从从图图中中可可以以看看到到，每每一一层层依依赖赖于于其其下下方方的的一一层，层与层之间有接口。层，层
19、与层之间有接口。因因此此，对对系系统统的的一一个个层层次次进进行行维维护护或或变变更更，势必引起其它各层作出相应的变更。势必引起其它各层作出相应的变更。业务过程业务过程应用软件应用软件应用软件应用软件支持软件支持软件硬件硬件 一一个个应应用用软软件件通通常常包包含含有有多多个个不不同同的的程程序序，不不同同的的程程序序针针对对不不同同的的数数据据操操作作，有有些些数数据据还还可可能能为为多多个个程程序序共共享享。如如图图，程程序序变变更更影影响响到到数数据据，也也影影响到其它程序的变更。响到其它程序的变更。程序程序1程序程序2程序程序3程序程序4程序程序5程序程序6程序程序7文件文件1文件文件
20、2文件文件3文件文件4文件文件5文件文件6 本本例例说说明明，当当需需要要对对软软件件进进行行修修改改、变变更更时时，应应评评估估其其影影响响，并并慎慎重重地地提提出建议，以提交审批。出建议，以提交审批。102.2.维护修改方案维护修改方案 软软件件的的维维护护、修修改改需需要要资资金金的的支支持持，需需要要对对投投资资做做精精心心安安排排，以以期期获获得得好好的的回回报报。因因此此，对对所所维维护护修修改改的的软软件件系系统统作作出出客客观观的的分分析析和和评评估估，制制定定合合理理、恰恰当当的的维维护护修修改改方方案案，是是维维护护取取得得成成功功的的前前提。提。根根据据实实际际软软件件维
21、维护护可可能能的的类类型型，可可以以有有下下面面几几种种可可选选的的维维护护方方案：案：-彻彻底底抛抛弃弃现现有有系系统统。当当系系统统不不能能对对现现有有业业务务过过程程产产生生有有效效作作用用时时选择选择-继继续续维维护护现现有有系系统统。当当系系统统运运行行平平稳稳，能能够够继继续续发发挥挥作作用用，用用户户也没有大的变更要求时，可选择此方案也没有大的变更要求时，可选择此方案-转转换换系系统统以以改改善善其其可可维维护护性性。当当系系统统质质量量因因经经常常变变更更，或或系系统统的的功功能能、性性能能增增加加及及改改善善后后，现现运运行行环环境境已已不不再再适适应应，并并且且系系统统维维
22、护护修改的需求仍然是经常性的时候，应选择此方案修改的需求仍然是经常性的时候，应选择此方案-以以一一新新系系统统代代替替现现系系统统。当当新新的的硬硬件件环环境境无无法法使使现现软软件件系系统统继继续续正正常常运运行行；或或虽虽现现系系统统仍仍然然能能使使用用，但但新新开开发发系系统统的的成成本本已已很很合合理理时，可考虑采用此方案时，可考虑采用此方案-综合方案综合方案。根据实际情况，选择上面几种方案进行综合维护工作。根据实际情况，选择上面几种方案进行综合维护工作113.3.维护过程与记载维护过程与记载 在在通通常常情情况况下下，一一个个规规范范的的维维护护过过程程，都都应应有有规规范范的的结结
23、构构化化维维护护文文档档的的生成机制。生成机制。由由于于维维护护过过程程是是由由一一系系列列变变更更请请求求所所触触发发的的，这这些些变变更更请请求求可可以以来来自自于于系系统统用用户户、管管理理层层或或者者是是客客户户。从从抽抽象象层层面面看看，所所有有维维护护过过程程都都有有相相同同的的基基本本活活动动，包包括括变变更更分分析析、版版本本规规划划、系系统统实实现现和和交交付付使使用用。下下图图描描述述了了系系统统维护过程的概况。维护过程的概况。变更请示变更请示影响分析影响分析版本规划版本规划变更实现变更实现缺陷修补缺陷修补平台适应平台适应系统增强系统增强系统发布系统发布12 在在维维护护过
24、过程程的的变变更更实实现现阶阶段段，通通常常修修改改系系统统描描述述、设设计计和和实实现现，以以反反映映对对系系统统所所做做的的变变更更。要要对对提提出出的的反反映映系系统统变变更更的的新需求进行详细分析，明确变更的内容。新需求进行详细分析，明确变更的内容。变变更更的的过过程程由由于于变变更更含含义义在在变变更更分分析析的的早早期期阶阶段段的的不不清清晰晰性性，而而变变得得曲曲折折反反复复，因因此此，对对变变更更需需求求应应进进行行反反复复的的修修改改和和有有效效性性验验证证，然然后后再再进进入入相相应应的的组组件件再再设设计计和和维维护护实实现现阶阶段段，最后通过测试，完成系统变更维护。其过
25、程如下图所示。最后通过测试，完成系统变更维护。其过程如下图所示。变更提议变更提议需求分析需求分析需求更新需求更新变更开发变更开发13 软件生命周期的所有阶段的文档，对软件维护工作都是十软件生命周期的所有阶段的文档，对软件维护工作都是十分重要的。这些文档将作为评估维护技术的有效性，确定软件分重要的。这些文档将作为评估维护技术的有效性，确定软件产品的产品的“优良优良”程度，以及确定维护的实际代价等的重要依据。程度，以及确定维护的实际代价等的重要依据。因此，维护活动过程的内容应详细记载。下面是维护记载的基因此，维护活动过程的内容应详细记载。下面是维护记载的基本内容参考：本内容参考：-程序标识程序标识
26、-源语句数源语句数-机器指令条数机器指令条数-使用的程序设计语言使用的程序设计语言-程序安装的日期程序安装的日期-自从安装以来程序运行的次数自从安装以来程序运行的次数-自从安装以来程序失效的次数自从安装以来程序失效的次数-程序变动的层次标识程序变动的层次标识-因程序变动而增加的源语句数因程序变动而增加的源语句数-因程序变动而减少的源语句数因程序变动而减少的源语句数-每个改动耗费的人时数每个改动耗费的人时数-程序改动的日期程序改动的日期-软件工程师的名字软件工程师的名字-维护要求表的标识维护要求表的标识-维护类型维护类型-维护开始和完成的日期维护开始和完成的日期-累计用于维护的人时数累计用于维护
27、的人时数-与完成的维护相联系的纯效益与完成的维护相联系的纯效益144.4.软件维护建议软件维护建议 维维护护过过程程应应该该可可以以视视同同一一个个缩缩微微了了的的软软件件开开发发过过程程，因因此此，在在软软件件维维护护过过程程中中和和维维护护完完成成后后，都都因因编编制制规规范范的的文文档档，如如为为软件使用者提供内容详实、完整的软件维护手册。软件使用者提供内容详实、完整的软件维护手册。软软件件维维护护手手册册主主要要包包括括软软件件系系统统说说明明、程程序序模模块块说说明明、操操作作环环境境、支支持持软软件件的的说说明明、维维护护过过程程的的说说明明等等，维维护护手手册册的的软软件使用部分
28、，还应介绍系统功能、性能及操作在维护后的变化。件使用部分，还应介绍系统功能、性能及操作在维护后的变化。维护申请表维护申请表 应应该该是是一一张张标标准准化化格格式式的的表表格格，用用以以表表达达软软件件维维护护修修改改的的要求，描述维护修改的建议。要求，描述维护修改的建议。维维护护申申请请表表也也称称软软件件问问题题报报告告表表，由由提提出出维维护护活活动动的的用用户户负负责责填填写写，完完整整的的描描述述导导致致出出现现错错误误的的环环境境(包包括括输输入入数数据据、全全部输出数据，以及其它有关信息部输出数据，以及其它有关信息)。对对于于适适应应性性或或完完善善性性维维护护要要求求，还还应应
29、该该提提供供简简短短的的需需求求说说明书。明书。15 编写软件维护修改建议编写软件维护修改建议 由由用用户户提提交交的的维维护护申申请请表表是是编编写写维维护护修修改改建建议议书书的的基基础础。通通过过维维护护管管理理员员和和系系统统管管理理员员，评评价价用用户户提提交交的的维维护护申申请请表表，确确定定用用户户维维护护要要求求的的合合理理性性，明明确确维维护护范范围围和和内内容容，制制定定软软件件组组织织内内部部应应该该执执行行的的软软件件维维护护修修改改建建议议。软软件件维维护护修修改改建建议主要包括以下信息：议主要包括以下信息：-满足维护申请表中提出的维护要求所需要的工作量满足维护申请表
30、中提出的维护要求所需要的工作量 -维护要求的性质维护要求的性质 -该项维护修改要求的优先次序该项维护修改要求的优先次序 -与维护修改有关的数据与维护修改有关的数据16 评价维护修改评价维护修改 软软件件生生命命周周期期所所有有阶阶段段生生成成的的文文档档是是评评价价维维护护修修改改活活动动的的依依据据。对对维维护护活活动动的的评评价价可可以以做做一一些些定定量量的的度度量量。至至少少可可以以从从以以下下7 7个个方方面面对对维维护护活活动动进进行评价：行评价：-每次程序运行平均失效的次数每次程序运行平均失效的次数-用于每一类维护活动的总人时数用于每一类维护活动的总人时数-平均每个程序、每种语言
31、、每种维护类型所做的程序变动数平均每个程序、每种语言、每种维护类型所做的程序变动数-维护过程中增加或删除一个源语句平均花费的人时数维护过程中增加或删除一个源语句平均花费的人时数-维护每种语言平均花费的人时数维护每种语言平均花费的人时数-一张维护申请表的平均周转时间一张维护申请表的平均周转时间-不同维护类型所占的百分比不同维护类型所占的百分比 根根据据对对维维护护工工作作的的定定量量度度量量，可可以以作作出出关关于于开开发发技技术术、语语言言选选择择、维维护护工工作作量量规规划划、资资源源分分配配及及其其它它相相关关方方面面的的决决策策，并并且且可可以以利利用用这这些些数数据据去去分分析和评价维护过程的质量，发现维护过程改进的方向和内容。析和评价维护过程的质量，发现维护过程改进的方向和内容。17