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

版权申诉
0 下载量 28 浏览量 更新于2024-07-06 收藏 237KB DOCX 举报
本文档是浪潮集团山东通用软件有限公司用户手册编制规范,旨在为公司产品提供一个用户手册编写规范,指导参与文档编制工作的人员,包括设计人员、编程人员、文档编制人员,以及其他参与文档工作的成员。 一、文档类别使用对象 本文档是为浪潮通用软件公司的产品提供一个用户手册编写规范,使用对象为浪潮通用软件公司参与文档编制工作的人员,包括设计人员、编程人员、文档编制人员,以及其他参与文档工作的成员。 二、引言 本文档的目的是为用户提供各种类型的文档,以供用户参阅和培训之用,提供相应的配套资料,辅助软件推向市场。 三、编制大纲 本文档提供公司产品用户手册的编制类型、编制大纲、编制风格、编制顺序以及用于编制人员最后进行的审核。 四、编写要求 1. 应该用统一的风格、确定的方法描述产品提供的所有功能。 2. 统一采用编制工具Word进行编写。 3. 描述之后的功能,应该具有如下的特点: 对于每一个功能的描述应该完整,从对应的实际业务、产品提供的相应功能以及对应此功能的一些相关操作等方面进行描述。 对于术语的描述分系统术语和基本概念,系统术语在整个系统的含义是统一的,在前言部分描述;基本概念在各个章节进行描述。 对于每个功能的描述不能有歧义。 4. 语言要简洁明快,表达准确。 5. 编写格式应统一: 封面的设计根据编写部门自己的需求,但应有公司的图标,封底应有公司的名称、地址、电话、传真、网址和E-mail地址; 目录用WORD97自动生成,采用正式格式,显示三级标题,页码右对齐,字体用小四号宋体; 正文的章、节格式用MSWORD。 五、审核鉴定 本文档的审核鉴定是为了确保文档的质量和一致性,审核人员应对文档的内容、格式和风格进行审核和评价。 六、结论 本文档是为浪潮通用软件公司的产品提供一个用户手册编写规范,旨在指导参与文档编制工作的人员,提高文档的质量和一致性,提高软件的推广和销售。