软件公司用户手册编制规范模板.doc

密级：机密用户手册编制规范V1.0 浪潮集团山东通用软件目录文档类别使用对象21引言31.1目标31.2范围31.3术语定义31.4参考资料31.5版序控制统计31.6版本更新统计42编制纲领521 编写要求522 文档分类623 用户使用手册编制纲领6231 序言7232 功效7233 附录824 用户安装手册编制纲领8241 序言9242 单机版安装及配制9243 网络版安装及配制9243 附录1025 系统管理员手册编制纲领103编写标准114审核判定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/102编制纲领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 21 使用步骤 22 具体描述221 进行此功效业务介绍222 操作步骤223 功效键、和项目说明224 举例225 特殊提醒及注意事项。 第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） 绘制进度表，以图表形式列出各阶段应产生文档、编制人员、编制主管、编制日期、完成日期、评审日期等。其次文档编写人员应有一定文字表示能力，而且应明确用户真正需求，真正从用户角度考虑问题；文档编写人员还应和程序员有对应交流，搞清程序员编写步骤，各个功效使用次序，搞清各个功效对应业务。 最终，文档编写人员应根据编写纲领认真编写文档。4审核判定确保文档质量和文档内容正确性、合理性，应对用户手册进行评审和判定工作，提出改善意见，以利整个文档质量提升。