软件公司用户手册编制规范(编辑修改稿)内容摘要:
中国最大的管理资源中心 第 6 页 共 13 页 2.编制大纲 2. 1 编写要求 1. 应该用统一的风格、确定的方法描述产品提供的所有功能。 2. 统一采用编制工具 Word进行编写。 3. 描述之后的功能,应该具有如下的特点: 1) 对于每一个功能的描述应该完整,从对应的实际业务、产品提供的相应功能以及对应此功能的一些相关操作等方面进行描述。 2) 对于术语的描述分系 统术语和基本概念,系统术语在整个系统的含义是统 中国最大的管理资源中心 第 7 页 共 13 页 一的,在前言部分描述;基本概念在各个章节进行描述。 对于每个功能的描述不能有歧义。 3) 语言要简洁明快,表达准确。 4. 编写格式应统一: 1) 封面的设计根据编写部门自己的需求,但应有 的图标,封底应有公司的名称、地址、电话、传真、网址和 Email 地址; 2) 目录用 WORD97 自动生成,采用正式格式,显示三级标题,页码右对齐,字体用小四号宋体;目录起始页第一行正中为“目 录”二字,字体为四号加黑宋体。 3) 正文的章、节格式用 MS WORD*的标题格 式,段内的字体应保持字体统一,用小四号宋体。 但特殊强调的需引起读者注意的条目,可用其它字体。 4) 正文的页眉 用五号宋体,格式如下: 章节名称 正文页码设置:位置为页面底端(页脚),对齐方式为外侧。 2. 2 文档分类 名 称 说 明 用户使用手册 目的:用户认真阅读本手册 ,可以快速、方便的使用本系统的功能。 作用:培训和参考的作用。 使用对象:使用本产品的用户以及培训本产品的市场、服务人员。 安装手册 目的:用户能正确地安装软件。 作用:帮助用户正确地安装使用软件。 使用对象:用户。 系统管理员手册 目的:对系统管理员提供的使用说明。 作用:使系统管理员对系统有一个大概的了解,提高系统管理员的工作效率,减少系统出错机率;减少服务人员的工作量。 中国最大的管理资源中心 第 8 页 共 13 页 使用对象:用户 2. 3 用户使用手册编制大纲 目 录 第一章 前言 1. 1 内容简介 1. 2 主要功能 1. 3 操作流程 1. 4 基本概念 第二章 功能 1 2. 1 使用流程 2. 2 具体描述 2. 2. 1 进行此功能的业务介绍 2. 2. 2 操作步骤 2. 2. 3 功能键、以及项目说明 2. 2. 4 举例 2. 2. 5 特殊提示及注意事项。软件公司用户手册编制规范(编辑修改稿)
阅读剩余 0%
本站所有文章资讯、展示的图片素材等内容均为注册用户上传(部分报媒/平媒内容转载自网络合作媒体),仅供学习参考。
用户通过本站上传、发布的任何内容的知识产权归属用户或原始著作权人所有。如有侵犯您的版权,请联系我们反馈本站将在三个工作日内改正。