用户手册制作规范_V1.00

文档编号： 密

级：

技术文件名称：用户手册制作规范 版 本：V1.0

文件质量等级：[单击此处键入文件质量等级]

拟制：

审核： 批准： [单击此处键入批准者姓名]

版本记录

目录

1

概述 ........................................................................................................................................................ 1-1 1.1 1.2 2

目的 ............................................................................................................................................ 1-1 范围 ............................................................................................................................................ 1-1

模板使用 ................................................................................................................................................ 2-1 2.1 2.2

模板 ............................................................................................................................................ 2-1 使用方法 .................................................................................................................................... 2-1 2.2.1 2.2.2

加载模板 ........................................................................................................................... 2-1 使用模板 ........................................................................................................................... 2-3

3 手册结构 ................................................................................................................................................ 3-1 3.1

A4手册 ....................................................................................................................................... 3-1 3.1.1 3.1.2 3.1.3 3.2

文件名称 ........................................................................................................................... 3-1 结构概述 ........................................................................................................................... 3-1 内容详解 ........................................................................................................................... 3-1

A5手册 ....................................................................................................................................... 3-7 3.2.1 3.2.2 3.2.3

文件名称 ........................................................................................................................... 3-7 结构概述 ........................................................................................................................... 3-7 内容详解 ........................................................................................................................... 3-7

4 词句规范 ................................................................................................................................................ 4-1 4.1 4.2 4.3

标题 ............................................................................................................................................ 4-1 段落 ............................................................................................................................................ 4-1 词句 ............................................................................................................................................ 4-2

4.4 4.5 4.6 4.7 4.8 A

项目列表 .................................................................................................................................... 4-2 表格 ............................................................................................................................................ 4-2 术语及缩略语 ............................................................................................................................ 4-3 标点 ............................................................................................................................................ 4-3 说明和注意 ................................................................................................................................ 4-3

附录-版本号升级说明 ....................................................................................................................... A -1 A.1 A.2

版本格式 .................................................................................................................................... A -1 版本升级规则 ............................................................................................................................ A -1

1

概述

1.1 目的

本文档为M2Micro 物联微电子(常熟) 有限公司的产品用户手册制作规范，内容包括手册模板的使用、手册样式介绍和词句的常用写作技巧，意在统一手册的版式，形成专属我司的用户手册风格。

1.2 范围

文档开发人员在制作用户手册时需遵守的规范内容。

2

模板使用

我司用户手册的主要制作工具为Word ，在制作说明书前，首先要加载手册模板，以保证基本

样式的统一。

2.1 模板

手册模板分为A4尺寸和A5尺寸两种，A4尺寸模板一般用作放入光盘中的电子版的用户手册，A5尺寸模板一般用作印刷版的用户手册。两套模板如下。

A4模板.dotA5模板.dot

2.2 使用方法

本文中以Word 2007为例介绍模板的使用，Word 2003使用方法基本相同。

2.2.1 加载模板

1. 创建新文件或打开已有的文件。 2. 点击office 按钮>>Word选项。

2模板使用

3. 在弹出的“Word 选项”窗口中，选择加载项>>管理>>模板，点击【转到】按钮。

4. 在弹出的“模板和加载项”窗口中，选择模板菜单栏，点击【选用】按钮，找到对应模板。并

勾选中“自动更新文档样式”前面的复选框。点击【确定】按钮。

2模板使用

5. 在Word 的“快速访问工具栏”中，“加载项”面板内，会自动加载模板的工具栏。

2.2.2 使用模板

加载模板后，首先需要点击【页面设置】按钮设置页面，然后对应的样式只需选中段落后，点击对应的按钮即可。

模板工具栏中的按钮说明如下。

3

手册结构

本章介绍手册的结构，包括A4尺寸的电子手册及A5尺寸的印刷手册。

3.1 A4手册

A4手册主要用在电子版本的用户手册，一般以存放至光盘中的形式发布。主要适用于软件系统类的或者具有较复杂操作类的产品，内容全面，包含原理、步骤、案例等一切需要用户了解的内容。

手册中，超链接格式均使用默认超链接样式，且保证链接可跳转（如网站等）。界面图片、照片等均保持原色彩。PDF 转换时，使用“标准”。

3.1.1 文件名称

文件存放名称为“手册名称_版本号”。

3.1.2 结构概述

用户手册的框架大致如下。

3.1.3 内容详解

以下介绍框架中每个结构所涉及的内容及样式。

物联微电子

用户手册制作规范

3手册结构

3.1.3.1 页面设置

因本手册为电子档文件，无留白页的问题。因此，“版式设置”中，页眉页脚设置为“首页不同”，表示每节首页和非首页的页眉可设置为不同样式；手册中插入的分节符均为“下一页”。

3.1.3.2 封面

独占一页，最后一行加分页符。

1. 公司名称：LOGO 宽度8cm ，左缩进3字符。使用“黑体+Arial”字体，一号。

3手册结构

2. 手册名称：1*1的单元格形式，左侧加边框，颜色为“深蓝淡色40%”，宽度4.5磅。

文字：两行文字时，第一行是产品名称，第二行是“用户手册”，使用“黑体+Arial”字体，小初。三行文字时，前两行是产品名称，第三行是“用户手册”，使用“黑体+Arial”，小一。段落设置为，左对齐1字符，段前6磅，段后6磅，行距1.1。

3. 手册版本：单元格最后一行，使用“Calibri ”字体，四号。右对齐。

4. 公司信息：正文字体，六号。段落设置无缩进，无格式，无行间距。最后一行后加分页符。 3.1.3.3 声明

声明：独占一页，内容不变，最后一行加分节符。

3.1.3.4 前言

独占一节，最后一行加分节符。包含“手册说明”、“内容简介”、“版本说明”和“本书约定”

3手册结构

四部分。

1. 手册说明：介绍本手册的主要内容。

2. 内容简介：以表格的形式，罗列每章标题及内容概述。

3. 版本说明：介绍本手册的更新版本。每次内容的增删改时，均需修改当前版本并填写档次修改

说明。同时更新封面的版本号。

3手册结构

版本号格式及升级说明，请参见附录A 版本号升级说明。

4. 本书约定：介绍本手册内的一些通用的约定。包括符号约定、标志约定等。 3.1.3.5 目录

独占一节，最后一行加分节符。

无页眉，有页码，页码居中，格式为Ⅰ、Ⅱ„„。

目录内容包括1级标题、2级标题、3级标题、附录1级标题和附录2级标题。附录1级标题的样式与1级标题相同，附录2级标题与2级标题的样式相同。

3.1.3.6 正文及附录

每一章占用一节，章尾最后一行加分节符。均使用模板样式。

3.1.3.7 页眉和页码

● “封面”、“声明”、“前言”无页眉无页码。“目录”无页眉有页码。“正文”及“附录”有页眉

有页码。

● 正文章节第一页无页眉，有页码。页码居中，每章从1开始编号，包含章节号。如1-3，表示

第1第3页。

3手册结构

非章节首页，有眉有页码。页眉为2*2表格形式，只保留中间横框。(1,1)单元格左对齐，内容

为公司的logo

和公司全称；

(1,2)单元格右对齐，内容为用户手册的名称；(1,3)单元格留空；(1,4)单元格右对齐，内容为当前页的章节号及章节标题。

3手册结构

3.2 A5手册

A5手册主要用在印刷版本的用户手册上，一般需要印刷成册放入产品包装盒中。主要适用于终端类产品的或者操作简单的产品，内容较固定，多数为介绍接口、安装等内容及简略功能操作。

手册中，超链接（如，网站等）均使用正文格式。界面图片、照片等均设置为灰度图，色差尽量明显。安装图和壳体图尽量使用线条图。PDF 转换时，使用“PDF/X-1a:2001”。

3.2.1 文件名称

文件存放名称为“手册名称_版本号”。

3.2.2 结构概述

用户手册的框架大致如下。

3.2.3 内容详解

3.2.3.1 页面设置

因本手册为印刷文件，需要考虑留白页及奇偶页的问题。因此，“页面设置”中设置了左侧0.8cm 的装订线位置。“版式设置”中，节起始位置为“奇数页”，表示章节开始均从奇数页开始。页眉页脚设置为“首页不同”“奇偶页不同”，表示每节首页、奇数页和偶数页的页眉可设置为不同样式；手册中插入的分节符均为“奇数页”。

3手册结构

书脊位

3.2.3.2 封面

使用AI(Adobe Illustrator)制作，封面封底在一张A4大小的面板上。

1. 手册名称：两行文字，第一行是产品名称，第二行是“用户手册”，使用“黑体+Arial”字体，

20pt 。

2. 手册版本：封面右下角，使用“Calibri ”字体，10pt 。 3. 公司信息：封底左下角，使用“宋体+Calibri”字体，8pt 。

3手册结构

3.2.3.3 声明

声明：独占一页，内容不变，最后一行加分节符。

3.2.3.4 前言

独占一节，最后一行加分节符。包含“手册说明”、“内容简介”、“版本说明”和“本书约定”四部分。

3手册结构

1. 手册说明介绍本手册的主要内容。

2. 内容简介：以表格的形式，罗列每章标题及内容概述。

3. 版本说明：介绍本手册的更新版本。每次内容的增删改时，均需修改当前版本并填写档次修改

说明。同时更新封面的版本号。

版本号格式及升级说明，请参见附录A 版本号升级说明。

4. 本书约定：介绍本手册内的一些通用的约定。包括名称约定和标志约定。 3.2.3.5 目录

独占一节，最后一行加分节符。

无页眉，有页码，页码居中，格式为Ⅰ、Ⅱ„„。

目录内容包括1级标题、2级标题、3级标题、附录标题。附录标题的样式与1级标题相同。

3手册结构

3.2.3.6 正文及附录

每一章占用一节，章尾最后一行加分节符。均使用模板样式。

3.2.3.7 页眉和页码

● “封面”、“声明”、“前言”无页眉无页码。“目录”无页眉有页码。“正文”及“附录”有页眉

有页码。

● 正文章节第一页无页眉，有页码。页码位置在右下角，从第1第1页起不分章节顺次编号，格

式为1、2„„。

3手册结构

非章节页，有页眉有页码。页眉页码分为奇偶页不同。

页眉为一行加下划线，偶数页页眉左对齐，内容为手册名称。奇数页页眉右对齐，内容为当前页的章节号及章节标题。

偶数页页码左对齐，奇数页页码右对齐。

4

词句规范

本章对用户手册的内容进行较细致规范。

4.1 标题

1. 下级标题不重复上一级标题的内容。

2. 不同结构体现不同章节的类型：描述类—名词性词组（指示灯说明）；过程类—动宾词组（配置

网络）。

3. 同类型、同级别的标题结构要保持一致。 4. 标题含义明确，不需要上下文解释。 5. 标题不出现疑问词。

6. 场景类标题（安装、配置）采用任务风格，基于用户的真实目的。 7. 标题中直接使用缩写，不带全称解释。 8. 标题中不带表示结束的标点。 9. 标题中不带上下标。

4.2 段落

1. 中心句置于断首，且一个段落只有一个主题句。 2. 段落长度，中文≤7行。

3. 语气使用陈述、肯定、祈使句，避免使用感叹句。 4. 句子中相思成分的词语结构相同。

5. 文不如图，字不如表。不出现连续3个以上的纯文字段落（步骤类的段落除外）。

4词句规范

6. 段落之间要有逻辑关系，如逻辑顺序、重要性顺序、时间顺序等。

4.3 词句

1. 不使用长句，一个句子不超过100个字（3行）。 2. 尽量不使用被动语态。

3. 直接使用陈述句，避免使用双重否定句。 4. 避免多名词或多形容词的修饰方式。 5. 描写出错信息时，避免使用第二人称。 6. 避免使用第三人称，限制使用第一人称。

7. 避免使用歧义、含义模糊、引起读者负面情绪的词，以及口语化的词。 8. 避免使用标示程度、强调语气的词。

4.4 项目列表

1. 连续的项目列表项≤9项，多余9项要进行适当的分组。 2. 采用同一句式相同语气。

3. 当需要对项目列表进行说明时，说明内容使用悬挂缩进。 4. 出现句子和短语混合的情况时，句后统一加句号。

4.5 表格

1. 至少包含2行2列。

2. 表内不出现空白单元格，无内容单元格内应填写“-”。 3. 重复内容不适用“同上”替代。 4. 表格设置行不跨页。 5. 表头使用加15%灰度的底纹。

4词句规范

4.6 术语及缩略语

1. 统一格式为：英文缩写（英文全称，中文全称）。如，AMR （Automatic Meter Reading，自动抄

表系统）。

2. A5尺寸的印刷手册不需要提供术语及缩略语表。 3. A4尺寸的电子手册，提供术语及缩略语表，放在附录中。

4.7 标点

1. 不适用冒号引到表格、题注、图注。 2. 不适用半个空号来编号。

3. 在文中使用交叉引用或链接时，不加引号。

4.8 说明和注意

1. 内容不包含表格、图形。

2. 可能造成人身安全或设备损坏的警示类信息，必须放在有此安全隐患的操作说明前面。 3. 内容简介，语气肯定果断。

4. 内容包含两个部分：不能做什么；原因和忽视造成的后果。 5. 内容禁止出现步骤。

A

附录-版本号升级说明

A.1 版本格式

手册版本号包含发行版号和版本号，中间以“-”连接，如“R20111214-V1.00”。 详细说明如下：

version ）Release ）

发行版号：内容为“R ”+“发行日期”。如，R20111214表示2011年12月14日发行的发行版本。

专业版号：内容为“P ”+“发行日期”。如，P20111214表示2011年12月14日发现的专业版本。

版本号：内容为“V ”+“主版本号”+“. ”+“子版本号”+“修正版本号”。如V1.23表示主版本号为1，子版本号为2，修正版本号为3。

A.2 版本升级规则

1. 发行号：“R ”+“发行日期”。版本升级后，需更新发行日期。 2. 版本号：“V ”+“主版本号”+“. ”+“子版本号”+“修正版本号” ● 初始版本号为V1.00。

● 当功能无变化，仅修正词句错误、更新参数或增加附录等时，主版本号和子版本号都不变，修

正版本号加1。如，V1.00→V1.01。

A-1

物联微电子

用户手册制作规范 A 附录-版本号升级说明

● 当项目在原有的基础上增加了部分功能时，主版本号不变，子版本号加1，修正版本号复位为

0。如，V1.03→V1.10。

● 修正版本最多为9个版本，当修正版增加到10个时，子版本号加1，修正版本号复位为0。如，

V1.09→V1.10

● 当项整体发生全局变化时，导致手册内容更新较多，如界面风格修改、产品操作流程修改等，

主版本号加1，子版本和修正版本号复位为0。如，V1.23→V2.00。

● 子版本最多为5个版本，当子版本增加到6个时，主版本号加1，子版本和修正版本号复位为

0。如，V1.50→V2.00。