浪潮集团山东通用软件有限公司用户手册编制规范.doc

密级：机密 用户手册编制规范用户手册编制规范 V1.0 1999 年 10 月 20 日 浪潮集团山东通用软件有限公司浪潮集团山东通用软件有限公司 目录 文档类别使用对象文档类别使用对象 .2 1引言引言 .3 1.1 目的.3 1.2 范围.3 1.3 术语定义.3 1.4 参考资料.3 1.5 版序控制记录.3 1.6 版本更新记录.4 2编制大纲编制大纲 .5 21 编写要求.5 22 文档分类.6 23 用户使用手册编制大纲.6 231 前言.7 232 功能.7 233 附录.8 24 用户安装手册编制大纲.8 241 前言.9 242 单机版的安装及配制.9 243 网络版的安装及配制.9 243 附录.10 25 系统管理员手册编制大纲.10 3编写原则编写原则 .11 4审核鉴定审核鉴定 .11 文档类别使用对象文档类别使用对象 文档类别 该文档是为浪潮通用软件公司的产品提供一个用户手册编写规范。 使用对象 该文档使用对象为浪潮通用软件公司参与文档编制工作的人员,包括设计人员、编 程人员、文档编制人员以及其他参与文档工作的成员。 1引言引言 1.1 目的 本文档是为公司产品的文档编写提供规范说明，其目的是： 1、为用户提供各种类型的文档，以供用户参阅和培训之用。 2、提供相应的配套资料，辅助软件推向市场。 1.2 范围 本文档提供公司产品用户手册的编制类型、编制大纲、编制风格、编制顺序以及用 于编制人员最后进行的审核。 1.3 术语定义 1.4 参考资料 国强财务软件 6.0 产品用户手册编写指南V1.3 1.5 版序控制记录 版序状 态 拟稿审核批准发布日期 1.0管理过程改善部 1.6 版本更新记录 *A - 增加 M - 修改 D - 删除 版本/修订版修改页码修改记录修改人日期 1.0初始版本99/10 2编制大纲编制大纲 21 编写要求 1. 应该用统一的风格、确定的方法描述产品提供的所有功能。 2. 统一采用编制工具 Word 进行编写。 3. 描述之后的功能，应该具有如下的特点： 1） 对于每一个功能的描述应该完整，从对应的实际业务、产品提供的相应功能 以及对应此功能的一些相关操作等方面进行描述。 2） 对于术语的描述分系统术语和基本概念，系统术语在整个系统的含义是统一 的，在前言部分描述；基本概念在各个章节进行描述。对于每个功能的描述 不能有歧义。 3） 语言要简洁明快，表达准确。 4. 编写格式应统一： 1）封面的设计根据编写部门自己的需求，但应有 的图标，封底应有公司的名称、地址、电话、传真、网址和 E-mail 地址； 2）目录用 WORD97 自动生成，采用正式格式，显示三级标题，页码右对齐，字 体用小四号宋体；目录起始页第一行正中为“目 录”二字，字体为四号加 黑宋体。 3）正文的章、节格式用 MS WORD*的标题格式，段内的字体应保持字体统一， 用小四号宋体。但特殊强调的需引起读者注意的条目，可用其它字体。 4）正文的页眉用五号宋体，格式如下： 章节名称 正文页码设置：位置为页面底端（页脚） ，对齐方式为外侧。 22 文档分类 名 称说 明 用户使用手册1、目的：用户认真阅读本手册,可以快速、方便的使用本系统 的功能。 2、作用：培训和参考的作用。 3、使用对象：使用本产品的用户以及培训本产品的市场、服 务人员。 安装手册1、目的：用户能正确地安装软件。 2、作用：帮助用户正确地安装使用软件。 3、使用对象：用户。 系统管理员手 册 1、目的：对系统管理员提供的使用说明。 2、作用：使系统管理员对系统有一个大概的了解，提高系统 管理员的工作效率，减少系统出错机率；减少服务人员的工作 量。 3、使用对象：用户 23 用户使用手册编制大纲 目目 录录 第一章第一章 前言前言 11内容简介 12主要功能 13操作流程 14基本概念 第二章第二章 功能功能 1 1 21 使用流程 22 具体描述 221 进行此功能的业务介绍 222 操作步骤 223 功能键、以及项目说明 224举例 225特殊提示及注意事项 。 。 。 。 。 。 。 。 。 。 。 。 。 。 。 。 。 。 。 。 。 。 。 。 第第 N N 章章 功能功能 n n 附录：附录： 附录 1 常用功能介绍 附录 2 技术支持 231 前言 提供手册的概述,在此可以说明编写这份手册的目的、指出本书适用的读者。 1、内容简介 简单地介绍编写的背景，系统适用的用户。 2、主要功能 是对该系统软件进行的简单讲解，所完成的功能介绍。 3、操作流程 操作流程的说明：应全面模拟用户操作，从安装、进入、初始化、到用户具 体操作的整个流程进行描述。 4、基本概念 基本概念：说明定义的术语在本手册的含义。 步骤说明：针对操作流程的每一步进行说明。如果在使用说明中有相应的解 释，应指明用户查找的位置。 232 功能 这部分包括用户使用的所有功能,这是用户使用手册的最大最重要的部分，要详细 的描述。 1、使用流程 描述具体功能的使用顺序。 如果功能之中有分类，比如，有些功能用户用不到，有些用得到，就要分开写流程。 2、具体描述 描述顺序是按照使用流程的每一步进行的。 1）进行此功能的业务介绍：对此功能进行简单的介绍,说明所能完成的功能。 2）操作步骤：用鼠标选择相应的功能,进入相应的界面,进行功能键以及栏目的介 绍。 3）举例：针对某一功能,对于一些比较难的问题,应该进行举例说明。 4）特殊提示及注意事项 在使用说明中，每一部分都会归纳一些问题,需要提示用户或者让用户注意， 应按照以下规定的格式进行编写： 格式：字体采用仿宋字，字号采用五号字 举例如下: 注意： 凭证制作人和凭证复核人不能是同一个人 233 附录 对一些在正文中描述不够详尽的地方，可在附录中进行补充；或是用户经常遇到的 问题及问题解答也可放在附录中。 24 用户安装手册编制大纲 目目 录录 第一章第一章 前言前言 11 内容简介 12 使用约定 第二章第二章 单机版的安装及配置单机版的安装及配置 21运行环境 22系统软件的安装 23安装后的系统配置 第三章第三章 网络版的安装及配置网络版的安装及配置 21运行环境 22系统软件的安装 23安装后的系统配置 附录附录 附录 1 安装过程提供的技术支持 附录 2 参考资料 241 前言 指明编制该手册的目的，指明预期的读者，简介该系统软件的操作系统，数据库， c/s 体系结构，界面特点，以及技术特色。 1、内容简介： 介绍本书提供的几个部分：简单介绍几个部分的大概内容。 2、使用约定 提示：提供安装过程的一些好的方法。 注意：安装过程中特殊注意的地方。 警告：指出危险动作或状态，不注意这些，会对你的安装造成破坏。 242 单机版的安装及配制 1、运行环境 1）硬件环境：列出运行本软件所要求的硬设备的最小配制。 微机要求包括型号，内存，硬盘。 显示器要求： 以及一些其他的设备：I/O 设备 2）软件环境：列出运行本软件所需要的支持软件 操作系统 程序语言以及数据库管理系统 2、安装单机版的系统软件 1）简单介绍单机版打包光盘定义以及内容。 2）介绍该软件单机版的安装步骤： 3、安装后的系统配置 介绍该软件安装完之后对配置信息的查看，以确定是否需要改动、是否是最优 配置；介绍系统配置的路径、以及在何处可以用得上系统配置。 另外，运行软件的时候，有时会出现数据库联结不成功。在这部分介绍会有几 种原因，并分别简述。 243 网络版的安装及配制 1、运行环境 除了对硬件环境提出要求外，对软件环境的要求应列出运行本软件所需的操作 系统、与操作系统兼容的网络环境、程序语言以及数据库管理系统。 另外，还应简单介绍一下安装网络和数据库所需注意事项和可参考的工具书。 2、安装网络版的系统软件 1）介绍该软件单机版的安装步骤： 2）如何进行系统环境配置； 3）数据库的默认用户及口令等。 3、安装后的系统配置 243 附录 附录 1 安装过程提供的技术支持。在此说明技术支持的几种方式，及常见安装疑难解 答。 附录 2 参考资料，应写上书名、作者、出版社 25 系统管理员手册编制大纲 目录目录 前言前言 第一章第一章硬件知识概述硬件知识概述 1.1 网卡的安装与配置 1.2 网络问题的诊断 1.3 站点增加时的操作 1.4 。 。 。 第二章第二章网络操作系统网络操作系统 1.1 网络操作系统的操作 1.2 网络操作系统的维护 1.3 网络操作系统的配置 1.4 。 。 。 第三章第三章数据库管理数据库管理 1.1 数据库的安装及维护 1.2 数据库的配置 1.3 。 。 。 第四章第四章系统软件的配置系统软件的配置 4.1 。 。 。 。 。 。 4.2 。 。 。 。 。 。 前言部分概述系统管理员应该完成的任务，系统管理员应具备的知识，一个称职 的系统管理员的所具有的素质。 参考资料：应注明都参考了那些资料，写上书名、作者及出版社。 3编写原则编写原则 编写原则是指是参与文档编写工作的人员如何编写文档，编写需具备的过程。 软件的形成过程是经过需求分析、软件设计阶段、编程阶段、测试阶段、运行与维 护阶段，各个阶段都必须有相应的文档编制。用户手册是最终提供给用户的参考资料， 必须结合需求分析以及软件的生命周期的各个过程来进行编写。 首先，文档编写主管应在文档编制需求提出后编写文档计划(文档编制需求)并把它 分发给全体相关人员，作为文档重要性的具体依据和管理部门文档工作责任的备忘录。 文档计划一般包括以下几方面内容： 1）列出应编制文档的目录； 2）提示编制文档应参考的标准； 3）指定文档管理员； 4）提供编制文档所需要的条件，落实文档编写人员、主管和所需经费以及编制工 具等； 5）明确保证文档质量的方法，为了确保文档内容的正确性、合理性，应采取一定 的措施，如评审、审稿、鉴定等； 6）绘制进度表，以图表形式列出各阶段应产生的文档、编制人员