软件用户指南说明： 1. 软件用户指南（SUM）描述了软件的手动用户应如何安装和使用计算机软件配置项（CSCI）、一组CSCI、软件系统或子系统。 它还包括软件操作的一些特殊方面，例如特定职位或任务的说明。 2.SUM 是为用户操作的软件而开发的，其用户界面需要在线用户输入或输出显示的解释。 如果软件嵌入在硬件-软件系统中，则可能不需要单独的SUM。1 前言 由于系统的用户指南或操作程序已经存在，因此本章应分为以下几项。 1.1 标识 本条款应包含本文件适用的系统和软件的完整标识，包括（如果适用）标识号、标题、缩写、版本号和发布号。 1.2 系统概述 本文应描述本文档所适用的系统和软件的用途。 应描述系统和软件的一般特征； 概述系统的开发、运行和维护历史； 确定项目的投资者、购买者、用户、开发商和支持组织； 确定当前和计划的运营地点； 并列出其他相关文件。 1.3 文件概述 本条款应概述本文件的目的和内容，并描述与其使用相关的保密性或透明度要求。 2 引用文件本章应列出本文件中引用的所有文件的编号、标题、修订版本和日期。 还应确定无法通过正常供应渠道获得的所有文件的来源。 3 软件概述本章应分为以下几项。
3.1 软件应用 本文应简要描述软件的预期用途。 应描述使用软件所带来的功能、操作改进和好处。 3.2 软件列表 此项应标识软件运行所必须安装的所有软件文件，包括数据库和数据文件。 标识应包括每个文件的保密性和透明度要求，以及在紧急情况下继续或恢复操作所需的软件的标识。 3.3 软件环境 本项应标明用户安装和运行软件所需的硬件、软件、手动操作以及其他资源。 （如果适用）包括以下说明： 必须提供的计算机设备，包括所需的显存量、所需的辅助存储数量和外围设备（如打印机和其他输入/输出设备）； b. 必须提供的通讯设备； C。 必须提供的其他软件，例如操作系统、数据库、数据文件、实用程序和其他支持系统； d. 必须提供的格式、流程或其他手动操作； e. 其他必须提供的设施、设备或资源。 3.4 软件组织和运行概述 本文应从用户的角度简要描述软件的组织和运行。 （如果适用）描述应包括： 从用户的角度概述软件的逻辑组件以及每个组件的用途/操作； b. 用户期望的性能特征，例如： 1) 可接受输入的类型、数量、速率； 2）软件生成的输出的类型、数量、精度和速度； 3）典型响应时间及其影响因素； 4）典型的处理时间及其影响因素； 5）局限性，例如干扰的可追溯性数量； 6）预期错误率； 7) 预期的可靠性。
C。 软件所执行的功能与其所连接的系统、组织或职位之间的关系； d. 为管理软件而采取的监管措施（例如密码）。 3.5 事故和备份状态及操作方法（如适用） 本文应说明在紧急情况下以及在不同的操作状态和方法下，用户如何处理软件的差异。 3.6 保密性和透明度 本条款应包含与软件相关的保密性和透明度要求的概述。 应包含针对非法复制软件或文档的警告（如果适用）。 3.7 帮助和问题报告 本节应确定在使用软件时遇到问题时获得帮助和报告问题所需遵循的联系点和程序。 4访问软件本章应包含针对首次/临时用户的分步过程。 应向用户提供足够的详细信息，以便他们在了解软件功能的详细信息之前能够可靠地访问该软件。 在适当的情况下，应包括标有“警告”或“小心”的安全提示。 4.1 软件的初次用户本文应分为以下几篇文章。 4.1.1 如果熟悉设备，本文应描述以下内容： 开机及调整电源的过程； b. 视觉显示屏的尺寸和功能； C。 光标形状，如果出现多个光标，如何指示活动光标，如何定位光标以及如何使用光标； d. 键盘布局以及不同类型按键和点击装置的功能； e. 如果需要特殊的操作顺序，则关闭电源过程。 4.1.2 访问控制 本节应概述用户可见的软件访问和保密功能。 （如果适用）本节应包括以下内容： 如何以及从谁处获取密码； b. 如何在用户的控制下添加、删除或更改密码； C。 存储和存储用户生成的输出报告和其他媒体。 标记相关的保密性和透明度要求。
4.1.3 安装和设置 本节应描述为识别或授权用户访问或在设备上安装软件、执行安装、配置软件、删除或覆盖以前的文件或数据以及软件的关键参数而必须执行的过程。操作。 4.2 启动过程 本节应提供启动工作的步骤，包括任何可用的选项。 如果遇到困难，应包括问题定义清单。 4.3 停止和暂停工作 本文应描述用户如何停止或中断软件的使用以及如何判断是正常结束还是暂停。 5 软件手册 本章应向用户提供软件的使用过程。 如果过程太长或复杂，则按照与本章相同的段落结构添加第6章、第7章……。 标题的含义与所选章节有关。 文档的组织取决于所描述的软件的特征。 例如，一种方法是根据用户工作的组织、分配的职位、工作地点以及必须完成的任务来定义章节。 对于其他软件，将第5章作为菜单手册、第6章作为所使用的命令语言手册、第7章作为功能手册更为合适。 详细程序在第 5.3 节中给出。 根据软件的设计，栏可以按功能、菜单、交易或其他基础来组织。 在适当的情况下，应包括标有“警告”或“小心”的安全提示。 5.1 功能 为了提供软件使用的概述，本条款应描述事务、菜单、功能或其他流程之间的关系。 5.2 约定 本文应描述软件使用的任何约定网站模板使用手册，例如使用的颜色、使用的警告音、使用的缩写习语表以及使用的命名或编码规则。
5.3 处理程序 本节应解释后续条款（功能、菜单、屏幕）的组织，并应描述完成该过程所需的顺序。 5.3.x（软件使用方面）本节的标题应标识所描述的功能、菜单、事务或其他过程。 （如果适用）本节应描述并给出以下选项和示例，包括：菜单、图标、数据输入表、用户输入、可能影响软件和用户界面的其他软件和硬件的输入、输出和诊断或错误消息，或可以提供在线描述或指导信息的报告和帮助设施。 给出的信息的格式应适合软件的具体特征。 但应该使用一致的描述风格，例如菜单的描述应该一致，交易的描述应该一致。 5.4 相关处理 本文应标识和描述任何非由用户直接调用且未在 5.3 中描述的软件执行的批处理、离线处理或后台处理。 应描述支持这些过程的用户责任。 5.5 数据备份 本节应描述创建和保留备份数据的过程，这些数据可用于在发生错误、缺陷、故障或崩溃时替换数据的主副本。 5.6 从错误、故障和紧急情况中恢复本文应提供重新启动或从处理过程中发生的错误和故障中恢复的详细步骤，以及确保紧急情况下操作连续性的详细步骤。 5.7 消息 本文应列出完成用户功能时可能出现的所有错误消息、诊断消息和通知消息，或参考列出这些消息的明细表。 应标记和描述每条消息的含义以及消息出现后要采取的操作。
5.8 快速参考手册 如果适用于软件，本节应提供或引用软件使用的快速参考卡或页面。 如果合适，快速参考手册应概述常用的功能键、控制序列、格式、命令或使用软件的其他方面。 6 注释 本章应包含有助于理解文档的一般信息（例如网站模板使用手册，背景信息、术语表、基本原理）。 本章应按字母顺序列出理解本文档所需的术语和定义、所有缩写词及其在文档中的含义。 如果第5章扩展为第6章至第N章，则本章应编号为第N章之后的下一章。附录表可用于提供单独发布的信息（例如图表、分类数据），以便于文件维护。 为了便于处理，附录可以装订成单独的卷。 附录应按字母顺序排列（A、B 等）。
