用户手册制作规范_V1.00.doc

文档编号： 密 级： 技术文件名称：用户手册制作规范 版 本：V1.0 文件质量等级： 拟制： 林琳 审核： 批准： 版本记录 日期 作者 版本 修订说明 2011-12-14 林琳 V1.00 初稿 目录 1 概述 1-1 1.1 目的 1-1 1.2 范围 1-1 2 模板使用 2-1 2.1 模板 2-1 2.2 使用方法 2-1 2.2.1 加载模板 2-1 2.2.2 使用模板 2-3 3 手册结构 3-1 3.1 A4手册 3-1 3.1.1 文件名称 3-1 3.1.2 结构概述 3-1 3.1.3 内容详解 3-1 3.2 A5手册 3-7 3.2.1 文件名称 3-7 3.2.2 结构概述 3-7 3.2.3 内容详解 3-7 4 词句规范 4-1 4.1 标题 4-1 4.2 段落 4-1 4.3 词句 4-2 4.4 项目列表 4-2 4.5 表格 4-2 4.6 术语及缩略语 4-3 4.7 标点 4-3 4.8 说明和注意 4-3 A 附录-版本号升级说明 A-1 A.1 版本格式 A-1 A.2 版本升级规则 A-1 概述 目的 本文档为的， 范围 文档开发人员在制作用户手册时需遵守的规范内容。 模板使用 我司用户手册的主要制作工具为Word，在制作说明书前，首先要加载手册模板，以保证基本样式的统一。 模板 手册模板分为A4尺寸和A5尺寸两种，A4尺寸模板一般用作放入光盘中的电子版的用户手册，A5尺寸模板一般用作印刷版的用户手册。两套模板如下。 使用方法 本文中以Word 2007为例介绍模板的使用，Word 2003使用方法基本相同。 加载模板 创建新文件或打开已有的文件。 点击office按钮Word选项。 在弹出的“Word选项”窗口中，选择加载项管理模板，点击【转到】按钮。 在弹出的“模板和加载项”窗口中，选择模板菜单栏，点击【选用】按钮，找到对应模板。并勾选中“自动更新文档样式”前面的复选框。点击【确定】按钮。 在Word的“快速访问工具栏”中，“加载项”面板内，会自动加载模板的工具栏。 使用模板 加载模板后，首先需要点击【页面设置】按钮设置页面，然后对应的样式只需选中段落后，点击对应的按钮即可。 模板工具栏中的按钮说明如下。 按钮 说明 页面设置 点击后，设置页面的初始值。包括“页边距”、“版式”、“文档网络”。 正文 正文的使用样式。 项目编号 项目符号和项目编号的使用样式。 表头 表格的表头的使用样式。 表头正文 表格的普通单元格的使用样式。 题注 图片、图注和表注的使用样式。 标题 对应级别的标题，有各自的使用样式。 手册结构 本章介绍手册的结构，包括A4尺寸的电子手册及A5尺寸的印刷手册。 A4手册 A4手册主要用在电子版本的用户手册，一般以存放至光盘中的形式发布。主要适用于软件系统类的或者具有较复杂操作类的产品，内容全面，包含原理、步骤、案例等一切需要用户了解的内容。 手册中，超链接格式均使用默认超链接样式，且保证链接可跳转（如网站等）。界面图片、照片等均保持原色彩。PDF转换时，使用“标准”。 文件名称 文件存放名称为“手册名称_版本号”。 结构概述 用户手册的框架大致如下。 内容详解 以下介绍框架中每个结构所涉及的内容及样式。 页面设置 因本手册为电子档文件，无留白页的问题。因此，“版式设置”中，页眉页脚设置为“首页不同”，表示每节首页和非首页的页眉可设置为不同样式；手册中插入的分节符均为“下一页”。 封面 独占一页，最后一行加分页符。 公司名称：LOGO宽度8cm，左缩进3字符。使用“黑体+Arial”字体，一号。 手册名称：1*1的单元格形式，左侧加边框，颜色为“深蓝淡色40%”，宽度4.5磅。 文字：两行文字时，第一行是产品名称，第二行是“用户手册”，使用“黑体+Arial”字体，小初。三行文字时，前两行是产品名称，第三行是“用户手册”，使用“黑体+Arial”，小一。段落设置为，左对齐1字符，段前6磅，段后6磅，行距1.1。 手册版本：单元格最后一行，使用“Calibri”字体，四号。右对齐。 公司信息：正文字体，六号。段落设置无缩进，无格式，无行间距。最后一行后加分页符。 声明 声明：独占一页，内容不变，最后一行加分节符。 前言 独占一节，最后一行加分节符。包含“手册说明”、“内容简介”、“版本说明”和“本书约定”四部分。 手册说明：介绍本手册的主要内容。 内容简介：以表格的形式，罗列每章标题及内容概述。 版本说明：介绍本手册的更新版本。每次内容的增删改时，均需修改当前版本并填写档次修改说明。同时更新封面的版本号。 版本号格式及升级说明，请参见附录A 版本号升级说明。