如何编写用户操作手册
发布网友
发布时间：2022-04-21 22:19
共1个回答
热心网友
时间：2023-08-17 15:52
格式约定
1.1.首页
(1).产品名称：“产品名称”+ 换行 + “用户手册”黑体小初 加粗、位于页面垂直水平居中处；
(2).版本号：“版本号：V+版本序列号”，位于产品名称下方，黑体 小二加粗、水平居中、垂直居中；
(3).公司名称：统一写成“************公司” 黑体小三 加粗、位于页面底端水平居中处；
1.2.目录
(1).目录 字体为黑体 二号 加粗、水平居中、位于页面顶端；
(2).目录列表：字体为宋体 五号 设置显示一至*标题；
1.3.标题和编号
1.3.1.一级标题
(1).编号为“1、2、3、”；
(2).样式名：标题1；
(3).字体格式：中文宋体 西文Times New Roman 小二、加粗、段前段后5磅、单倍行距；
(4).大纲级别1级；
1.3.2.二级标题
(1).编号为“1.1、1.2、1.3、2.1、2.2、2.3”；
(2).样式名：标题2；
(3).字体格式：中文宋体 西文Times New Roman 四号、加粗、段前段后5磅、单倍行距；
(4).大纲级别2级；
1.3.3.*标题
(1).编号为“1.1.1、1.1.2、1.1.3、1.2.1、1.2.2、1.2.3”；
(2).样式名：标题3；
(3).字体格式：中文宋体 西文Times New Roman 小四、加粗、段前段后5磅、单倍行距；
(4).大纲级别3级；
1.3.4.四级标题
(1).编号为“1.1.1.1、1.1.1.2、1.1.1.3、”；
(2).样式名：标题4；
(3).字体格式：中文宋体 西文Times New Roman 五号、加粗、段前段后5磅、单倍行距；
(4).大纲级别4级；
1.3.5.编号设置
(1).一级编号：(1)、(2)、(3)、----“编号1”样式，文本之前缩进2字符；
(2).二级编号：A、B、C、----“编号2”样式，文本之前缩进3字符；
(3).*编号：i,ii,iii、----“编号3”样式，文本之前缩进4字符；
1.4.正文
(1).正文：宋体五号、1.5倍行距、段首缩进2个字符；
(2).“”窗口名称、路径名称、标签名称，〖〗普通菜单项、或树状结构菜单项，【】窗口中的按钮、→连续选择菜单或子菜单或树状结构路径标记；
(3).提示标记：【注意】：、【举例】：、【提示】：、【操作前提】：，单独一行，宋体五号加粗，不缩进；
(4).截图：边框不完整的须添加与所截图片颜色相近的边框，保持截图的完整性，一些难以用语言描述的内容可以在截图上用宋体五号红色字体标注解释，在保证界面元素完整的前提下，缩小浏览器的界面再进行截图，可以使所截的图片更清晰，同时注意截图工具的使用，控制截图文件的大小。
(5).图注：包含章节编号，样式如“图 5-1” 宋体五号，位于图片下方，水平居中，引用图注用语：“如图 5-1所示：”。
1.5.页眉页脚
页眉：宋体 五号 居中/居左 下加横线粗细1.5磅 首页不设置页眉，从第2页目录开始设置。
页脚：设置页码：宋体 五号 居中 首页不设置页码，从第2页目录开始设置，初始值为1。
编写要求
2.1.编写内容
(1).完整性
质量良好的用户手册，至少应该是能够包括软件产品的所有相关内容，能够指导用户顺利的安装、设置和使用软件。保证内容的全面性和完整性是把握用户手册质量的重要方面。
(2).一致性
用户手册的内容不仅要保证其全面性和完整性，还要确保它与一起发行的软件版本的实际功能相一致。
(3).准确性
用户手册编写完毕后最好能安排人员进行审核，保证它遵守完整性、语言、拼写与语法、连贯性与格式方面的规则，及时发现和纠正手册中的错误，如错别字、图片序号与描述不匹配等等。
(4).统一性
整份用户手册的描述语言、描述风格尽量统一，方便用户的阅读。
2.2.编写风格
(1).描述规范准确，在描述内容、说明方法、提出见解时都应准确无误，恰如其分。用词应标准、统一、规范。
(2).假设用户什么都不懂，应该详细地描述操作过程中的每一步。
(3).尽可能将信息制成表格，表格可改善信息的可读性。在需要根据不同的基础描述对象，或在不同的维度间比较对象时，可应用表格。
(4).通俗易懂，尽量不使用较深奥的计算机术语，如果不可避免，应该给予适当的解释和说明。
(5).层次分明，每节的内容必须明确，这样用户可以通过目录很方便地查到自己所需要的内容；注意段的划分，每段不要太长，突出重点，否则用户不容易获得其中的精华。
(6).前后一致，在用户手册中使用的概念、术语的用词要前后保持一致。
(7).分析可能的失败情形并告诉用户如何处理发生的问题。如果你有一本的解决问题的手册，指导用户去那里寻找更多的信息。
(8).图文并茂，适当举例，实例有助于用户迅速掌握概念，并更好地理解其内容。
