软件开发用户手册

《软件开发用户手册》由会员分享，可在线阅读，更多相关《软件开发用户手册（4页珍藏版）》请在金锄头文库上搜索。

1、软件开发用户手册软件用户手册(sum)解释：1.软件用户手册(sum)描述手工操作该软件的用户应如何安装和使用一个计算机 软件配置项(csci), 组csci, 个软件系统或子系统。它还包括软件操作的一些特别的方 面，诸如，关于特定岗位或任务的指令等。2.Sum由用户操作的软件开发，具有需要在线用户输入或解释输出显示的用户界面。 如果软件嵌入到硬件软件系统中，可能不需要单独的金额，因为系统的用户手册或操作程 序已经可用1引言1 . 1标识本条应包含本文档适用的系统和软件的完整标识，(若适用)包括标识号、标题、缩略 词语、版本号和发行号。1.2系统概述本文应简要描述适用于本文件的系统和软件的用途

2、。应描述系统和软件的一般特性； 总结系统的开发、运行和维护历史；确定项目的投资方、需求方、用户、开发商和支持机 构；确定当前和计划的作业地点；并列出其他相关文件。1.3文件概述本条应概述本文档的用途和内容，并描述与其使用有关的保密性或私密性要求。2引 用文件本章应列出本文件中引用的所有文件的编号、标题、版次和日期。还应确定无法通过 正常供应渠道获得的所有文件的来源。3.软件概述本章应分为以下几条。3.1软件应用本文将简要描述软件的预期用途。应说明其能力、操作改进以及通过使用本软件获得 的效益。3.2软件清单本条应标识为了使软件运行而必须安装的所有软件文件，包括数据库和数据文件。标 识应包含每份

3、文件的保密性和私密性要求和在紧急时刻为继续或恢复运行所必需的软件的 标识。3.3软件环境本条款应确定用户安装和运行软件所需的硬件、软件、手动操作和其他资源。(如适 用)包括以下标识：a必须提供的计算机设备，包括需要的内存数量、需要的辅存数量及外围设备(诸如 打印机和其他的输入/输出设备)；1/4b.必须提供的通信设备；c、 必须提供的其他软件，如操作系统、数据库、数据文件、实用程序和其他支持系 统；d、必须提供的格式、流程或其他手动操作；e、其他必须提供的设施、设备或资源。 3.4软件组织和运行概述本条应从用户的角度出发，简要描述软件的组织与操作。（若适用）描述应包括：a从 用户的角度来看的软

4、件逻辑部件和每个部件的用途/操作的概述；b.用户期望的性能特性, 例如：1）可接受输入的类型、数量和比率；2）软件产生的输出的类型、数量、精度和速率；3）典型的响应时间和影响它的因素； 4）典型的处理时间和影响它的因素；5）限制，例如可追踪的事件数目；6）预期的错误率； 7）预期的可靠性。c、软件执行的功能与其接口的系统、组织或位置之间的关系；d、为管理软件而采 取的监督措施（例如密码）。3.5事故及备用状态和运行方式（若适用）本条应解释在紧急时刻以及在不同运行状态和方式下用户处理软件的差异。 3.6保密性和私密性本节应概述与软件相关的保密和隐私要求。（如适用）应包括对非法复制软件或文件 的警

5、告。3.7帮助和问题报告本条应标识联系点和应遵循的手续，以便在使用软件时遇到的问题时获得帮助并报告 间题。4访问软件本章应包括首次/临时用户的逐步流程。应向用户提供足够的详细信息，以便用户在 了解软件的功能细节之前能够可靠地访问软件。适当时，应包括标有“警告”或“注意” 的安全提示。4.1软件的第一用户本条应分为以下几条。4.1.1熟悉设备如果合适，本条应描述以下内容：a.打开和调整电源的过程；b. 可视化显示屏幕的大小与能力；c、光标形状：如果有多个光标，如何识别活动光标、如何定位光标以及如何使用光 标；d、键盘布局以及不同类型按键和点击设备的功能；e、如果需要特殊的操作顺序， 请关闭电源。

6、2/44.1.2访问控制本条应提供用户可见的软件访问与保密性特点的概述。（若适用）本条应包括以下内容a. 怎样获得和从谁那里获得口令；b、如何在用户控制下添加、删除或更改密码；c. 与用户生成的输出报告及其他媒体的存储和标记有关的保密性和私密性要求。 4.1.3安装和设置本条款应描述识别或授权用户访问或在设备上安装软件、执行安装、配置软件、删除 或覆盖以前的文件或数据以及关键软件操作参数所必须执行的过程。4.2启动过程本条应提供开始工作的步骤，包括任何可用的选项。万一遇到困难时，应包含一张问 题定义的检查单。4.3停止和挂起工作本文将描述用户如何停止或中断软件的使用，以及如何判断它是正常结束还

7、是终止。5软件指南本章应向用户提供使用软件的过程。如果过程太长或太复杂，按本章相同的段结构添 加第6章，第7章?，标题含义与所选择的章有关。文档的组织依赖于被描述的软件的特 性。例如，一种办法是根据用户工作的组织、他们被分配的岗位、他们的工作现场和他们 必须完成的任务来划分章。对其他的软件而言，让第5章成为菜单的指南，让第6章成为 使用的命令语言的指南，让第7章成为功能的指南更为合适。在5.3的子条中给出详细的 过程。依赖于软件的设计，可能根据逐个功能，逐个菜单，逐个事务或其他的基础方式来 组织条。在合适的地方应包含用“警告”或“注意”标记的安全提示。5.1能力为了概述软件的使用，本文应简要描

8、述事务、菜单、功能或其他处理之间的关系。5.2协议本条应描述软件使用的任何约定，例如使用的颜色、使用的警告铃声、使用的缩略词 语表和使用的命名或编码规则。 5. 3处理过程本文应解释后续文章（功能、菜单、屏幕）的组织，并描述完成流程所需的顺序。5.3. X （软件使用方面）本条的标题应标识被描述的功能、菜单、事务或其他过程。（若适用）本条应描述并给 出以下各项的选择与实例，包括：菜单、图标、数据录人表、用户输入、可能影响软件与 用户的接口的来自其他软硬件的输入、输出、诊断或错误消息、或报警和能提供联机描述 或指导信息的帮助设施。给出的信息格式应适合于软件特定的特性.但应使用一种二致的 描述风格

9、，例如对菜单的描述应保持一致，对事务描述应保持一致。5.4相关处理本条款应识别和描述软件执行的任何批处理、离线或后台处理，这些处理不是用户直 接调用的，也不是5.3中描述的。应说明支持此类处理的用户的责任。3/45.5数据备份本条应描述创建和保留备份数据的过程，这些备份数据在发生错误、缺陷、故障或事 故时可以用来代替主要的数据拷贝。5.6错误，故障和紧急情况时的恢复本条应给出重新启动或从处理过程中的错误和故障中恢复的详细步骤，以及确保紧急 情况下连续运行的详细步骤。5.7信息本条应列出完成用户功能时可能发生的所有错误消息、诊断消息和通知性消息，或引 用列出这些消息的附录。应标识和描述每一条消息的含义和消息出现后要采取的动作。 5.8快速引用指南如果适用于本软件，本节应提供或参考本软件使用的快速参考卡或页面。如果适用， 快速参考指南应概述常用功能键、控制序列、格式、命令或软件使用的其他方面。6注本章应包含有助于理解本文档的一般信息（例如背景信息、词汇表、原理）。本章应包 含为理解本文档需要的术语和定义，所有缩略语和它们在文档中的含义的字母序列表。如 果第5章扩展到了第6章至第n章，本章应编号为第n章之后的下一章。附录附录可用于提供单独发布用于文档维护的信息（如图表、分类数据）。为了便于处理 附录可以单独装订成册。附录应按字母顺序排列（a、B等）。4/4