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

浪潮通软公司

用户手册编写规范

PAGE1

PAGE

密级：机密

用户手册编制规范

V1.0

浪潮集团山东通用软件有限公司

编号：

时间：2021年x月x日

书山有路勤为径，学海无涯苦作舟

页码：第PAGE1页共NUMPAGES1页

第

第PAGE1页共NUMPAGES1页

目录

TOC\o1-3文档类别使用对象 2

1．引言 3

1.1目的 3

1.2范围 3

1.3术语定义 3

1.4参考资料 3

1.5版序控制记录 3

1.6版本更新记录 4

2．编制大纲 5

2．1编写要求 5

2．2文档分类 6

2．3用户使用手册编制大纲 6

2．3．1前言 7

2．3．2功能 7

2．3．3附录 8

2．4用户安装手册编制大纲 8

2．4．1前言 9

2．4．2单机版的安装及配制 9

2．4．3网络版的安装及配制 9

2．4．3附录 10

2．5系统管理管控员手册编制大纲 10

3．编写原则 11

4．审核鉴定 11

文档类别使用对象

文档类别

该文档是为浪潮通用软件公司的产品提供一个用户手册编写规范。

使用对象

该文档使用对象为浪潮通用软件公司参与文档编制工作的人员,包括设计人员、编程人员、文档编制人员以及其他参与文档工作的成员。

1．引言

1.1目的

本文档是为公司产品的文档编写提供规范说明，其目的是：

为用户提供各种类型的文档，以供用户参阅和培训之用。

提供相应的配套资料，辅助软件推向市场。

1.2范围

本文档提供公司产品用户手册的编制类型、编制大纲、编制风格、编制顺序以及用于编制人员最后进行的审核。

1.3术语定义

1.4参考资料

国强财务软件6.0产品用户手册编写指南 V1.3

1.5版序控制记录

版序状态

拟稿

审核

批准

发布日期

1.0

管理管控过程改善部

1.6版本更新记录

*A-增加M-修改D-删除

版本/修订版

修改页码

修改记录

修改人

日期

1.0

初始版本

99/10

2．编制大纲

2．1编写要求

应该用统一的风格、确定的方法描述产品提供的所有功能。

统一采用编制工具Word进行编写。

描述之后的功能，应该具有如下的特点：

对于每一个功能的描述应该完整，从对应的实际业务、产品提供的相应功能以及对应此功能的一些相关操作等方面进行描述。

对于术语的描述分系统术语和基本概念，系统术语在整个系统的含义是统一的，在前言部分描述；基本概念在各个章节进行描述。对于每个功能的描述不能有歧义。

语言要简洁明快，表达准确。

编写格式应统一：

封面的设计根据编写部门自己的需求，但应有

的图标，封底应有公司的名称、地址、电话、传真、网址和E-mail地址；

目录用WORD97自动生成，采用正式格式，显示三级标题，页码右对齐，字体用小四号宋体；目录起始页第一行正中为“目录”二字，字体为四号加黑宋体。

正文的章、节格式用MSWORD*的标题格式，段内的字体应保持字体统一，用小四号宋体。但特殊强调的需引起读者注意的条目，可用其它字体。

正文的页眉用五号宋体，格式如下：

章节名称

正文页码设置：位置为页面底端（页脚），对齐方式为外侧。

2．2文档分类

名称

说明

用户使用手册

1、目的：用户认真阅读本手册,可以快速、方便的使用本系统的功能。

2、作用：培训和参考的作用。

3、使用对象：使用本产品的用户以及培训本产品的市场、服务人员。

安装手册

1、目的：用户能正确地安装软件。

2、作用：帮助用户正确地安装使用软件。

3、使用对象：用户。

系统管理管控员手册

1、目的：对系统管理管控员提供的使用说明。

2、作用：使系统管