软件用户手册公司内部用模板

软件用户手册1. 范围1.1 标识本条应描述本文档所适用系统和软件的完整标识，适用时，包括其标识号、名称、缩略名、版本号和发布号。1.2 系统概述本条应概述本文档所适用系统和软件的用途。它还应描述系统与软件的一般特性；概述系统开发、运行和维护的历史；标识项目的需方、用户、开发方和保障机构等；标识当前和计划的运行现场；列出其他有关文档。1.3 文档概述本条应概述本文档的用途和内容，并描述与它的使用有关的保密性方面的要求。2. 引用文档本章应列出引用文档的编号、标题、编写单位、修订版及日期，还应标识不能通过正常采购活动得到的文档的来源。3. 软件综述3.1 软件应用本条应用简要说明软件预期的用途，并应描述对软件使用所期望的能力、运行改进和收益情况。3.2 软件清单本条应标识使软件运行而必须安装的所有软件文件，包括数据库和数据文件。标识应包含每一文件的保密性考虑以及紧急时刻继续或恢复运行所需的软件的标识。3.3 软件环境本条应描述用户安装并运行该软件所需的硬件、软件、手工操作和其他的资源。（若适用）包括以下方面：a） 应提供的计算机设备，包括需要的内存数量、辅存数量及外围设备（如打印机和其他的输入/输出设备）；b） 应提供的通信设备；c） 应提供的其他软件，例如操作系统、数据库、数据文件、实用程序和其他的支持系统；d） 应提供的表格、规程或其他的手工操作；e） 应提供的其他设施、设备或资源。3.4 软件组织和操作概述本条应从用户的角度出发，简要描述软件的组织与操作。（若适用）描述应包括：a） 从用户的角度，概述软件逻辑部件和每个部件的用途/操作。b） 用户可能期望的性能特性，例如：1) 可接受的输入的类型、数量、速率；2) 软件产生的输出类型、数量、准确性和速率；3) 典型的响应时间和影响它的因素；4) 典型的处理时间和影响它的因素；5) 限制，例如可追踪的事件数目；6) 预期的错误率；7) 预期的可靠性。c） 该软件执行的功能与接口系统、组织或位置之间的关系。d） 为管理软件而能够采取的监控措施（例如口令）。3.5 意外事故及运行的备用状态和方式（若适用）本条应说明在紧急时刻及在不同运行状态和方式下用户处理软件的差异。3.6 保密性本条应概述与本软件相关的保密性考虑，适用时还应包括对软件或文档进行非授权复制的警告信息。3.7 帮助和问题报告本条应标识联系方式、获得帮助和报告软件使用中遇到的问题所应遵循的规程。4. 软件入门4.1 软件的首次用户4.1.1 熟悉设备需要时，本条应描述以下内容：a） 打开与调节电源的成规；b） 可视化显示屏幕的大小与能力；c） 光标形状，如果出现了多个光标如何标识现行的光标，如何定位光标和如何使用光标；d） 键盘布局和不同类型键与点击设备的功能；e） 需要特殊的操作顺序时关闭电源的规程。4.1.2 访问控制本条应概述对用户可见的软件的访问与保密性方面特征。（若适用）本条应包括以下内容：a） 如何获得与何处获得口令；b） 如何在用户的控制下添加、删除或更改口令；c） 与用户生成的输出报告及其他媒体的存储和加标记有关的保密性考虑。4.1.3 安装和设置本条应描述在指定的设备上访问或安装软件、执行该安装、配置该软件、删除或覆盖以前的文件或数据、以及输入软件操作参数所必须执行的规程。4.2 启动本条应提供开始工作的逐步的规程，包括任何可用的选项。本条还应提供遇到问题时用于问题确定的检查单。4.3 停止和挂起本条应描述用户如何停止或中断软件的使用，以及如何判断是否为正常结束或停止。5. 使用指南本章应向用户提供使用软件的规程。如果规程太长或太复杂，按本章相同的条结构添加第6章，第7章等，标题含义与所选择的章有关。文档的组织依赖于被文档化的软件的特性。例如，一种办法是根据用户工作的组织、他们被分配的位置、他们的工作现场或他们必须完成的任务来划分章。对其它软件而言，第五章可依为菜单指南，第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. 注释本章应包括有助于了解文档的所有信息（例如：背景、术语、缩略语或公式）。3