Word手册制作的基本原则 - 常见误区与改进方法
· 小村 豪 · Word, 手册制作, 文档设计, 业务改进
操作手册、作业流程说明、维护手册、内部运营文档。 这类文档真正在日后产生影响的,往往不是文笔本身,而是有没有把Word当成”只靠外观来调整的工具”来使用。
一开始看起来很快捷的做法,比如
- 只靠加粗和字号来制作标题
- 用空格或Tab键反复敲击来对齐位置
- 反复按Enter键来分页
- 手动输入目录和页码引用
- 把修改意见直接以红字的形式混在正文里
只要混入这些做法,每次改版都会随之崩坏。
本文把制作手册时真正需要用到的Word基础知识,以”常见误区”与”最佳实践”并列对照的方式加以整理。
前提是以.docx为主要格式、以Word桌面版为中心的使用场景。
目录
- 先说结论
- 不要把Word当成手工对齐的工具
- 常见误区与最佳实践对照表
- 实务中应该把握的要点
- 手册用Word模板的最低配置
- 分发前的检查
- 总结
1. 先说结论
先把结论列出来。制作手册时真正起作用的,是以下4点。
-
把结构交给Word的功能来管理 标题、编号、目录、引用、分页控制不应靠手工输入,而应交给Word的样式、字段和分节符来管理。
-
不要把对齐交给空白字符 空格、Tab连续敲击、连续空行,每次修改时都会被破坏。应该使用段落设置、缩进、表格和分节。
-
不要把审阅意见混入正文 修改意见不应以红字混在正文里,而应通过批注和修订记录分开管理。这样最终定稿时,哪些内容已经确定就一目了然。
-
在分发前统一更新自动化元素 目录、页码、交叉引用、图表编号应在最后统一更新一次。转成PDF之前,也要确认辅助功能是否合规。
2. 不要把Word当成手工对齐的工具
制作手册时最重要的一点,是把外观和结构区分开来。
举例来说,以下这些内容本质上属于”结构”。
- 章、节、小标题
- 步骤1、步骤2、步骤3
- 图2-1、表3-2
- 参见第4章
- 只有封面页不显示页码
- 改版时的修订履历
然而,在容易崩坏的文档中,这些”结构”往往全部依靠”外观调整”来凑合。
- 把字号调大,让它看起来像标题
- 手动输入
1. - 用空格来对齐
- 用Enter键换页
- 直接写”参见第3页”
采用这种方式,只要改动一个地方,其他地方就会一并被打乱。
Word本身就内置了标题样式、目录、段落设置、多级列表、页眉/页脚、分节符、题注、修订记录、辅助功能检查等,用于以结构来管理文档的各项功能。 在制作手册时,仅仅用上这些基础功能,就能大幅减少事故。
3. 常见误区与最佳实践对照表
| 项目 | 常见误区 | 最佳实践 |
|---|---|---|
| 标题 | 只靠加粗+字号来划分章节 | 使用标题1 / 标题2 / 标题3 |
| 对齐 | 用空格或Tab连续敲击来对齐 | 使用段落设置、缩进、制表位、表格 |
| 分页控制 | 连续按Enter键跳到下一页 | 使用分页符、分节符 |
| 目录 | 手动输入目录 | 使用标题样式 + 自动目录 |
| 步骤编号 | 手动输入1. 2. 3. |
使用编号列表 / 多级列表 |
| 页眉页脚 | 每一页都直接输入 | 使用页眉 / 页脚与页码功能 |
| 图表 | 只是贴图,没有标题 | 添加题注、正文说明、替代文字 |
| 修改 | 红字正文或颜色标记原样保留 | 使用修订记录与批注进行审阅 |
| 引用 | 手写”参见第3页”“见上图” | 使用交叉引用并统一更新字段 |
| 格式规则 | 每个人做出来的外观都不一样 | 提前确定好模板和样式 |
4. 实务中应该把握的要点
4.1 只靠加粗和字号来做标题
常见误区 把字调大加粗,做到”看起来像标题”就算完成。
问题所在 Word不会把这一行识别为正式的标题。 在导航窗格中很难跳转,自动目录也无法收录。从辅助功能的角度看,只有外观的标题也处于不利地位。
最佳实践
给章、节、小标题分别指定标题1 / 标题2 / 标题3样式。
想改变外观时,不要逐行调整加粗或字号,而是编辑样式本身。
4.2 用空格或Tab连续敲击来对齐位置
常见误区 用空格把操作名称和说明文字之间的间隔填满,用Tab连续敲击把右侧的版本号推齐,插入多个空行来充当段间距。
问题所在 文字只要增加一个字符就会整体错位。 更改字体、增加段落、转成PDF、多人协同编辑时都很容易发生偏移。
最佳实践 位置和留白应该交给段落设置,而不是字符来控制。 使用缩进、制表位、段前段后间距,必要时使用表格。
4.3 连续按Enter键来分页
常见误区 想让下一章从新的一页开始,于是连续按多次Enter键来推送。
问题所在 只要上一页多出一行,后面的内容就会整体错位。 可能出现空白页混入、标题单独留在前一页、页眉页脚在意料之外的位置切换等问题。
最佳实践
章节开头使用分页符,需要切换页码或页眉/页脚处理方式的位置使用分节符。
出现错位时,打开¶编辑标记的显示,确认分页符和段落标记所在的位置。
4.4 目录、编号、交叉引用不要手动输入
常见误区
手动制作目录页,每次都重新输入章节名称和页码。
在正文中直接输入1. 2. 3.或1.1 1.2。
直接写”参见第12页”“见图3”这类文字。
问题所在 每次改版都容易出现更新遗漏。 容易出现只更新了页码、但标题名称仍是旧版本这类事故。
最佳实践 利用标题样式制作自动目录。 步骤使用编号列表,章节体系使用多级列表来管理。 图号、页码、章节号的引用统一使用交叉引用或字段,并在最后统一更新一次。
4.5 页眉/页脚和版本号不要逐页直接输入
常见误区 把文档名称、版本号、页码直接输入在每一页上。 为了让封面页看起来不同,手动逐一调整外观。
问题所在 容易忘记更新版本号,页码出现偏差,中途只想改变附录部分的格式时也容易崩坏。
最佳实践 文档名称、版本号、页码统一放入页眉/页脚。 只想让封面页单独处理时,使用”首页不同”设置;想按章节或附录切换时,使用分节符并取消”与上一节相同”的页眉/页脚链接。
4.6 把修订记录、批注、图表分开管理
常见误区 用红字写下”这里要改”“未确认”“待商议”,并原样保留在最终版本中。 只贴整屏截图,没有图号也没有说明。
问题所在 分不清哪些是正文,哪些是审阅中的备注。 也容易导致最终版本中残留审阅痕迹。
最佳实践 修改本身用修订记录,商议或指示用批注来区分。 图表添加题注,必要时设置替代文字。
5. 手册用Word模板的最低配置
一开始不需要精心设计的模板。 最初做到以下程度就足够了。
| 要素 | 用途 | 最低规则 |
|---|---|---|
| 文档标题 | 封面、开头标题 | 放置文档名称、版本号、制作日期、修订日期 |
标题1 |
章 | 纳入自动目录 |
标题2 |
节 | 纳入自动目录 |
标题3 |
小标题 | 仅在需要时使用 |
正文 |
正文 | 基础段落 |
| 编号列表 | 步骤 | 用于操作步骤 |
| 项目符号 | 补充 | 用于列举条件或注意事项 |
| 图题注 | 图号 | 图1、图2…… |
| 表题注 | 表号 | 表1、表2…… |
| 页眉/页脚 | 共通信息 | 文档名称、版本号、页码 |
进一步把以下运营规则也确定下来,之后会更省心。
- 原稿采用
.docx - 对外分发使用PDF
- 改版时使用修订记录
- 分发前更新字段
- 分发前进行辅助功能检查
6. 分发前的检查
手册转成PDF之前,至少要确认以下内容。
6.1 全部字段更新
用Ctrl + A全选正文后更新字段。
可以减少目录、页码、交叉引用、图表编号的更新遗漏。
6.2 整理修订记录与批注
确认是否还残留着审阅过程中的修订记录和批注。 需要注意”只是关闭了显示”但实际内容仍然保留的情况。
6.3 检查标题级别
检查章节体系是否统一使用标题1 / 2 / 3。
如果这一层级不统一,目录和导航就会出现混乱。
6.4 检查图片和表格
确认图表是否带有编号、图片是否过大,以及正文中是否说明清楚了应该关注的内容。
6.5 辅助功能检查
运行辅助功能检查,确认标题、替代文字、对比度、表格结构等方面没有问题。 如果前提是要以PDF形式分发,提前在Word阶段整理好会更安全。
7. 总结
用Word制作手册时,最应该避免的是连结构也依靠手工来维持。
- 标题交给样式
- 步骤交给编号功能
- 目录交给自动生成
- 分页交给分页符和分节符
- 图表交给题注
- 审阅交给修订记录和批注
- 引用交给交叉引用
- 分发前统一更新并检查
归根结底,就是不要把Word只当作”打字工具”,而要把它当作管理文档结构的工具来使用。
手册真正体现差距的时刻,不是刚写完的那一刻,而是需要修改的那一刻。 每次改版都会崩坏的文档,往往在内容本身出问题之前,Word的基本规则就已经崩坏了。
反过来说,只要把这些基本要点做到位,文档的可维护性就会大幅提升。 一开始并不需要追求精美的设计。 先把标题、编号、目录、分页、审阅这5件事从手工操作中解放出来,才是最实用的起点。
相关文章
共享相同标签的最新文章。可以围绕相近的主题进一步加深理解。
在 Word 手册中稳定排布图片、图表与截图的方法
整理在 Word 手册中让图片、图表与截图不易错乱的方法:嵌入型排布、题注、锚点、间距、模板化与发布前检查。
用 PerfView 与 dotnet-trace 定位“变慢”的原因 ── .NET 性能排查实务入门
当业务应用出现“变慢”“CPU 占满”“偶尔卡死”时,该用哪个工具看什么?本文梳理 PerfView 与 dotnet-trace 的分工、CPU 采样的解读方法(inclusive/exclusive)、用 ThreadTime 排查阻塞时间,以及与 EventSourc...
面向 BtoB 企业的 Google 广告小预算运营 ── 用每月数万日元做出成果的设计与每周操作流程
本文面向希望以每月数万日元预算启动 Google 广告的 BtoB 企业,是一份实务指南。内容整理了平均每日预算与结算上限的运作原理、转化跟踪的搭建、聚焦高意向关键词、否定关键词与搜索字词报告的每周运营方法,以及小预算下的出价策略选择,均以 Google 官方资料为依据。
打造能被地区名搜索到的网站 ── 中小企业的本地SEO实战指南(地区页面与Google商家资料)
用「地区名称+行业」搜索却找不到自家公司的中小企业,适合看这篇。内容涵盖修正本地SEO的先后顺序:整理Google商家资料、统一NAP信息、设计地区页面、网站端的基础建设,以及在Search Console上衡量效果,全部以Google官方信息为依据整理成实务步骤。
Windows 事件日志・ETW 入门 ── 让业务应用程序的日志接入操作系统标准机制
Windows 业务应用程序的日志,是不是只靠文件日志来解决?事件日志与 ETW,是运维人员和操作系统标准工具所能看到的另一层记录。本文整理三种手段的分工方式、.NET 中的写入方法、通过 EventSource 进行的 ETW 埋点、收集与排查的实务做法,以及来源未注册、...
常见问题
汇总了咨询这一主题时常见的问题。
- 用Word制作手册时,首先应该注意什么?
- 把外观和结构分开管理。章节划分、步骤编号、目录、分页控制、引用不应靠加粗或空格堆砌,而应交给Word的功能:标题用样式,步骤用编号列表,目录用自动目录,分页控制用分页符和分节符,引用用交叉引用。靠手工调整出来的文档,每次改版都会崩坏。
- 为什么只靠加粗和字号做标题不行?
- 因为Word不会把这一行识别为正式的标题。这样一来,在导航窗格中很难跳转,自动目录也无法收录它。从无障碍访问的角度看,只有外观的标题也处于不利地位。应该给章、节、小标题分别指定'标题1 / 标题2 / 标题3'样式,想改变外观时不要逐行修改,而是编辑样式本身。
- 连续按Enter键分页会带来什么问题?
- 只要上一页多出一行,后面的内容就会整体错位。可能出现空白页混入、标题单独留在前一页、页眉页脚在意料之外的位置切换等问题。章节开头应该使用分页符,需要切换页码或页眉页脚处理方式的位置应该使用分节符。出现错位时,可以打开编辑标记显示来检查。
- 分发手册前应该检查哪些内容?
- 至少要检查5个方面。用Ctrl + A全选后更新字段,防止目录、页码、交叉引用、图表编号出现更新遗漏;确认是否残留修订记录和批注;检查标题级别是否统一;确认图表编号和尺寸;运行辅助功能检查,确认标题、替代文字、对比度、表格结构等没有问题。
作者简介
本文作者的个人简介页面。
Go Komura
小村软件有限公司 代表
以 Windows 软件开发、技术咨询与故障排查为中心,擅长难以复现的故障调查,以及既有资产仍在运行的项目。