系统使用手册模板

XXX系统使用手册 Version : 1.0 编制 : 审核 : 日期 : 2008-8-12 XXX公司 研发中心 文档修订历史纪录 日期 版本 说明 编制 审核 2008-8-12 1.0 创建                                             目录 1.    目的    1 1.1.    阅读对象    1 1.2.    如何使用本手册    1 1.3.    相关文档    1 1.4.    约定    1 2.    软件概述    2 2.1.    功能和特点    2 2.2.    新增特色    2 2.3.    获取技术支持    3 3.    软件环境    3 3.1.    安装准备    3 3.2.    硬件安装    3 4.    软件安装    3 5.    使用指南    4 5.1.    概述    4 5.2.    处理过程    4 5.2.1.    XXXX    4 5.2.2.    XXXX    4 5.3.    出错处理    4 6.    附录    5 1. 目的 [说明本用户手册的编写目的。] [示例：“《用户手册》将向用户介绍 亚德 ABC 软件，并帮助用户迅速安装和运行该软件。通过本手册，您将学会如何使用视觉控制等崭新功能，并为您提供软件使用中遇到的问题的解决办法以及获得资源与帮助的渠道。” ] 1.1. 阅读对象 [说明本手册的预期阅读对象。] [示例：“本手册的编写对象为期望通过 Intranet 或 Internet 进行动态数据操作的用户。手册中也为不太熟悉 Internet 的用户提供了基本的教程。” ] 1.2. 如何使用本手册 [说明本手册的阅读方法，要求针对不同类型的用户提供相应的使用指导。] [示例：“您既可按顺序阅读每一章，也可根据索引中的词条直接获得所需的信息。下表可以指导您使用本手册。] 如果您是 请阅读 计算机新手 附录Ａ　“如何使用鼠标” 亚德 ABC 的新用户   准备安装 亚德 ABC   ．．．．．．       ” 1.3. 相关文档 [说明与本手册使用相关的其他文档，包括名称、版本、与本手册的关系等。] [示例：“亚德 ABC 软件提供了纸制印刷文档（本手册）与多种在线格式的用户手册。在线用户手册更为完整和即时，如果本手册与在线用户手册有区别，您应按在线用户手册的说明进行操作。您可经常访问 Web 站点： WWW.CQHRSOFT.COM.CN/PRODUCT/SUPPORT/MANUAL 以获取最新的在线用户手册。”  ] 1.4. 约定 [说明有关本手册使用的一些约定，包括对用户了解相关知识的约定；本手册文字格式、图表含义的约定；有关本软件使用的惯用语法约定等。] [示例１：“本手册假定您对 HTML，JavaScript 有基本的了解。” ] [示例２：“本手册采用的其他约定如下所示： 下划线：附录Ａ——“词汇表索引”中包含的术语 ：请参阅本手册的相关章节] [示例３：“本手册采用以下记号对语法进行描述： |  ：可选择的项用竖线 ｜ 隔开； [　] ：方括号 [　] 内部的项是可选的； { 　}：可选项中必须选择一个选项，那么可选项包含在花括号｛　｝中，    并由竖线 | 隔开。”  } 2. 软件概述 2.1. 功能和特点 [概要介绍本软件的开发目的、功能部件、主要功能、性能、安全保密要求等。如果说明的内容较多，本节应分小节逐一介绍。] [示例：“欢迎您使用亚德 SCANNER扫描图象和进行图象处理。本软件有如下功能和特点： 快速扫描和处理：．．． 中英文界面：．．． 批量图象扫描：．．． 支持BMP、GIF、JPG．．．等图象格式 支持黑白、灰度、256色和真彩图象 支持任何与WINDOWS兼容的扫描仪、视频俘获卡、显示卡和打印输出设备” ] 2.2. 新增特色 [说明该版本的软件与以前版本的软件相比，本次版本的软件的新增特色、改动和重要的错误修正。] [示例：“ 自2.0版的变化: 新增特色 语音输入 小改动 更快速的启动 错误修正 修正了打开多于16个窗口时发生的错误” ] 2.3. 获取技术支持 [列出本软件用户可以获取的技术支持方式和内容、联系方式、用户为获取技术支持应做的准备工作或注意事项等。技术支持的内容包括：产品升级、用户注册、使用教程与培训、维护、软件错误反馈等。本节内容较多时，其组织方式可以是：按内容分小节叙述；或本节仅做概要的说明，详细内容作为用户手册的附录或指明用户取得详细技术支持信息的渠道（如在线的技术支持、软件的帮助文件等）。] 3. 软件环境 3.1. 安装准备 [说明在软件安装之前，对系统配置的要求，用户应当完成的其他相关准备活动。] [系统配置要求应当说明软件正常运行所需的系统（软件和硬件）的最低配置，如：操作系统类型、版本；应用软件及版本；机型、内存与外存大小；外围设备；通讯设备等。建议提供本软件运行的最优系统配置。] [用户须完成的相关准备活动可能有：预备空白软盘；备份工作；了解存放于本手册之外的最新安装信息等。] [示例１：“安装 CPU Killer 2000前，请确认计算机是否满足以下最小系统要求： Pentium Ⅲ 800 MHz 或以上的处理器 128 Mb 的内存 硬盘空间：最小安装需600 Mb，完全安装需900 Mb ．．．．．．” ] [示例２：“要运行安装程序，您需要准备一张已格式化的空白3.5英寸高密度软盘。安装前，建议您备份计算机上的所有重要文件。另外，请您阅读光盘上的Setup.txt文件，了解安装的最新信息。” ] 3.2. 硬件安装 [本节提供硬件安装的有关信息。本节内容较多时，可以作为单独一章，并置于软件安装之前。本节相关内容在文档的其他部分如有说明，应在本节适当处指明。] [硬件安装主要说明重要安全说明、安装步骤和硬件技术规格。] [应在必要的地方用醒目标识提供安全警告。] 4. 软件安装 [说明软件安装的详细步骤、与软件安装有关的安全和保密信息、安装过程中可能出现的问题和排除方法。 软件安装的步骤应按照不同的安装方式（首次安装或升级安装）、不同的操作环境或应用软件环境分别进行叙述。安装步骤应当详细，并配合实际的安装界面进行描述。] [安全与保密信息指在安装过程中或安装后系统首次启动时，用户可见的安全与保密特性。如：登陆密码说明；从何处获得密码；如何添加或删除密码等。] [示例１：“您可以选择以下方式安装亚德 ABC 2000： 从亚德 ABC 98升级到亚德 ABC 2000 ．．．．．． 执行新安装 WINDOWS 3.x环境下安装 WINDOWS 95/98环境下安装 安装选项” ] [示例２：“每次启动ABC 2000时，都回出现对话框要求您登陆。请键入用户名和密码以登陆到系统。如果不知道密码，请与系统管理员联系。关于密码的详细信息请参阅软件的“帮助”中“索引”选项中的“密码”一条对应的内容。” ] 5. 使用指南 [本章为用户提供软件的使用指南。如果软件功能较多，使用步骤比较复杂，本章可细分为若干章，每章的名称对应该章的内容。] [章节的具体组织取决于软件的特性。某些软件可能按用户的工作区域、任务进行说明。对另外一些软件来讲，使用指南的组织方式可以是：第五章介绍软件的菜单，第六章介绍命令语言，第七章介绍各项具体功能。根据软件的设计，章节可按工作窗口、菜单结构、功能结构、事务处理结构等分类方式逐一加以介绍。安全警告标志应当在相应地方标明。] 5.1. 概述 [本小节对本章需要介绍的内容进行简要介绍，并说明软件使用中的术语、缩略语、惯用约定等，或指明术语、缩略语、惯用约定等在本手册的相关位置。] 5.2. 处理过程 [此处对本节内容的组织方式（如按功能、菜单、窗口）进行说明，同时应说明必须按特定顺序执行的处理。] 5.2.1. XXXX [本节的名称应当对应所描述的功能、菜单、或窗口等。说明的内容包括：菜单、窗口、表格的样式和内容、图标、输入、输出、诊断、错误或警告信息、帮助的使用等。] 5.2.2. XXXX ．．．．．． 5.3. 出错处理 [说明软件运行过程中可能遇到的问题和相应处理措施。] 6. 附录 [附录的内容和本手册主体的内容不能重复，主体的相关部分应向用户指明可以参考的相应附录部分。以下内容均可作为附录： 技术支持信息 错误排除 硬件技术规格 词汇表及索引 相关基础知识 命令索引 提示信息索引 功能键索引  ]