某软件公司用户手册编制规范109514.docx

《某软件公司用户手册编制规范109514.docx》由会员分享，可在线阅读，更多相关《某软件公司用户手册编制规范109514.docx（17页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、 浪潮通软公司 用户手册编写规范 密级：机密密用户手册编编制规范V1.0 浪潮集团山山东通用软软件有限公公司1目录文档类别使使用对象21引言31.1目的的31.2范围围31.3术语语定义31.4参考考资料31.5版序序控制记录录31.6版本本更新记录录42编制大大纲521 编编写要求522 文文档分类623 用户使用用手册编制制大纲62311 前言72322 功能72333 附录824 用用户安装手手册编制大大纲82411 前言92422 单机版版的安装及及配制92433 网络版版的安装及及配制92433 附录1025 系系统管理员员手册编制制大纲103编写原原则114审核鉴鉴定11文档类别使

2、使用对象文档类别该文档是为为浪潮通用用软件公司司的产品提提供一个用用户手册编编写规范。使用对象该文档使用用对象为浪浪潮通用软软件公司参参与文档编编制工作的的人员,包包括设计人人员、编程程人员、文文档编制人人员以及其其他参与文文档工作的的成员。1引言1.1目的的本文档是为为公司产品品的文档编编写提供规规范说明，其其目的是：1、 为用户提供供各种类型型的文档，以以供用户参参阅和培训训之用。2、 提供相应的的配套资料料，辅助软软件推向市市场。1.2范围围本文档提供供公司产品用用户手册的的编制类型型、编制大大纲、编制制风格、编编制顺序以以及用于编编制人员最最后进行的的审核。1.3术语语定义1.4参考考

3、资料国强财务软软件6.00产品用户户手册编写写指南V1.3 1.5版序序控制记录录版序状态拟稿审核批准发布日期1.0管理过程改改善部 1.6版本本更新记录录*A - 增加 M - 修改改 D - 删除除版本/修订订版修改页码修改记录修改人日期1.0初始版本99/1002编制大大纲21 编编写要求1. 应该用统一一的风格、确确定的方法法描述产品品提供的所所有功能。2. 统一采用编编制工具WWord进进行编写。3. 描述之后的的功能，应应该具有如如下的特点点：1） 对于每一个个功能的描描述应该完完整，从对对应的实际际业务、产产品提供的的相应功能能以及对应应此功能的的一些相关关操作等方方面进行描描述

4、。2） 对于术语的的描述分系系统术语和和基本概念念，系统术术语在整个个系统的含含义是统一一的，在前前言部分描描述；基本本概念在各各个章节进进行描述。对对于每个功功能的描述述不能有歧歧义。3） 语言要简洁洁明快，表表达准确。4. 编写格式应应统一：1） 封面的设计计根据编写写部门自己己的需求，但但应有 的图标，封封底应有公公司的名称称、地址、电电话、传真真、网址和和E-maail 地址址；2） 目录用WOORD977自动生成成，采用正正式格式，显显示三级标标题，页码码右对齐，字字体用小四四号宋体；目录起始始页第一行行正中为“目 录”二字，字字体为四号号加黑宋体体。3） 正文的章、节节格式用MMS

5、 WOORD*的的标题格式式，段内的的字体应保保持字体统统一，用小小四号宋体体。但特殊殊强调的需需引起读者者注意的条条目，可用用其它字体体。4） 正文的页眉眉用五号宋宋体，格式式如下： 章节名名称 正文页码设设置：位置置为页面底底端（页脚脚），对齐齐方式为外外侧。 22 文文档分类名 称说 明用户使用手手册1、目的：用户认真真阅读本手手册,可以以快速、方方便的使用用本系统的的功能。2、作用：培训和参参考的作用用。3、使用对对象：使用用本产品的的用户以及及培训本产产品的市场场、服务人人员。安装手册1、目的：用户能正正确地安装装软件。2、作用：帮助用户户正确地安安装使用软软件。3、使用对对象：用户

6、户。系统管理员员手册1、目的：对系统管管理员提供供的使用说说明。2、作作用：使系系统管理员员对系统有有一个大概概的了解，提提高系统管管理员的工工作效率，减减少系统出出错机率；减少服务务人员的工工作量。33、使用对对象：用户户23 用户使用用手册编制制大纲 目目 录 第一章章 前言11 内容简介12 主要功能13 操作流程14 基本概念 第二章章 功功能1 21 使用流流程 22 具具体描述2211 进行行此功能的的业务介绍绍2222 操作作步骤2233 功能能键、以及及项目说明明224 举例225 特殊提示及及注意事项项。 第N章章 功功能n 附录： 附录录1 常常用功能介介绍 附录录2 技技

7、术支持2311 前言提供手册的的概述,在在此可以说说明编写这这份手册的的目的、指指出本书适适用的读者者。1、内容简简介 简简单地介绍绍编写的背背景，系统统适用的用用户。2、主要要功能是对该该系统软件件进行的简简单讲解，所所完成的功功能介绍。3、操作流流程 操作流程程的说明：应全面模模拟用户操操作，从安安装、进入入、初始化化、到用户户具体操作作的整个流流程进行描描述。4、基本概概念 基本概念念：说明定定义的术语语在本手册册的含义。 步骤骤说明：针针对操作流流程的每一一步进行说说明。如果果在使用说说明中有相相应的解释释，应指明明用户查找找的位置。2322 功能能这部分包括括用户使用用的所有功功能,

8、这是是用户使用用手册的最最大最重要要的部分，要要详细的描描述。1、使用流流程描述具体功功能的使用用顺序。如果功能之之中有分类类，比如，有有些功能用用户用不到到，有些用用得到，就就要分开写写流程。2、具体描描述描述顺序是是按照使用用流程的每每一步进行行的。1） 进行此功能能的业务介介绍：对此此功能进行行简单的介介绍,说明明所能完成成的功能。2） 操作步骤：用鼠标选选择相应的的功能,进进入相应的的界面,进进行功能键键以及栏目目的介绍。3） 举例：针对对某一功能能,对于一一些比较难难的问题,应该进行行举例说明明。4） 特殊提示及及注意事项项在使用说明明中，每一一部分都会会归纳一些些问题,需需要提示用

9、用户或者让让用户注意意，应按照照以下规定定的格式进进行编写：格式：字体体采用仿宋宋字，字号号采用五号号字举例如下:注意： 凭证制作人人和凭证复复核人不能能是同一个个人2333 附录对一些在正正文中描述述不够详尽尽的地方，可可在附录中中进行补充充；或是用用户经常遇遇到的问题题及问题解解答也可放放在附录中中。24 用用户安装手手册编制大大纲 目 录 第一章章 前言 111 内容容简介 122 使用用约定 第二章章单机版版的安装及及配置21 运行环境22 系统软件的的安装23 安装后的系系统配置 第三章章网络版版的安装及及配置21 运行环境22 系统软件的的安装23 安装后的系系统配置 附录附录1

10、安装过程程提供的技技术支持附录2 参考资料料 2411 前言指明编制该该手册的目目的，指明明预期的读读者，简介介该系统软软件的操作作系统，数数据库，cc/s体系系结构，界界面特点，以以及技术特特色。1、内容简简介：介绍本书提提供的几个个部分：简简单介绍几几个部分的的大概内容容。2、使用约约定 提提示：提供供安装过程程的一些好好的方法。 注注意：安装装过程中特特殊注意的的地方。 警警告：指出出危险动作作或状态，不不注意这些些，会对你你的安装造造成破坏。2422 单机版版的安装及及配制1、运行环环境 1）硬硬件环境：列出运行行本软件所所要求的硬硬设备的最最小配制。 微机要要求包括型型号，内存存，硬

11、盘。 显示器器要求： 以及一一些其他的的设备：II/O设备备 2）软软件环境：列出运行行本软件所所需要的支支持软件 操作系系统 程序语语言以及数数据库管理理系统2、安装单单机版的系系统软件 1） 简单介绍单单机版打包包光盘定义义以及内容容。2） 介绍该软件件单机版的的安装步骤骤：3、安装装后的系统统配置介绍该该软件安装装完之后对对配置信息息的查看，以以确定是否否需要改动动、是否是是最优配置置；介绍系系统配置的的路径、以以及在何处处可以用得得上系统配配置。另外，运运行软件的的时候，有有时会出现现数据库联联结不成功功。在这部部分介绍会会有几种原原因，并分分别简述。2433 网络版版的安装及及配制1

12、、运行环环境除了对硬件件环境提出出要求外，对对软件环境境的要求应应列出运行行本软件所所需的操作作系统、与与操作系统统兼容的网网络环境、程程序语言以以及数据库库管理系统统。另外，还应应简单介绍绍一下安装装网络和数数据库所需需注意事项项和可参考考的工具书书。2、安装网网络版的系系统软件 1） 介绍该软件件单机版的的安装步骤骤：2） 如何进行系系统环境配配置；3） 数据库的默默认用户及及口令等。3、安装装后的系统统配置2433 附录附录1安装过程提提供的技术术支持。在在此说明技技术支持的的几种方式式，及常见见安装疑难难解答。 附录22参考资料，应应写上书名名、作者、出出版社25 系系统管理员员手册编

13、制制大纲 目录 前言第一章 硬件知识概概述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编写原原则编写原则是是指是参与

14、与文档编写写工作的人人员如何编编写文档，编编写需具备备的过程。软件的形成成过程是经经过需求分分析、软件件设计阶段段、编程阶阶段、测试试阶段、运运行与维护护阶段，各各个阶段都都必须有相相应的文档档编制。用用户手册是是最终提供供给用户的的参考资料料，必须结结合需求分分析以及软软件的生命命周期的各各个过程来来进行编写写。首先，文档档编写主管管应在文档档编制需求求提出后编编写文档计计划(文档档编制需求求)并把它它分发给全全体相关人人员，作为为文档重要要性的具体体依据和管管理部门文文档工作责责任的备忘忘录。文档档计划一般般包括以下下几方面内内容：1） 列出应编制制文档的目目录；2） 提示编制文文档应参考

15、考的标准；3） 指定文档管管理员；4） 提供编制文文档所需要要的条件，落落实文档编编写人员、主管和所需经费以及编制工具等； 5） 明确保证文文档质量的的方法，为为了确保文文档内容的的正确性、合合理性，应应采取一定定的措施，如如评审、审审稿、鉴定定等；6） 绘制进度表表，以图表表形式列出出各阶段应应产生的文文档、编制制人员、编编制主管、编制制日期、完完成日期、评评审日期等等。其次文档编编写人员应应有一定的的文字表达达能力，而而且应明确确用户的真真正需求，真真正从用户户的角度考考虑问题；文档编写写人员还应应与程序员员有相应的的交流，弄弄清程序员员的编写步步骤，各个个功能的使使用顺序，弄弄清各个功功能对应的的业务。 最后后，文档编编写人员应应按照编写写大纲认真真编写文档档。4审核鉴鉴定保证文档的的质量以及及文档内容容的正确性性、合理性性，应对用用户手册进进行评审和和鉴定工作作，提出改改进意见，以以利整个文文档质量的的提高。