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