乐于分享
好东西不私藏

技术文档写作坑点-文档冗余

技术文档写作坑点-文档冗余
文档写作的坑 · 第2篇

冗余的温柔刀:删掉20%,意思一点没变

它不疼,你甚至感觉不到它,但它让文档变长、变散、变水

一次让我醍醐灌顶的审校

我帮人审校过一篇操作指南,原文1800字。我删了360字,大概20%。然后把删减版给原作者看,问他:"你觉得少了什么?"

1800
原文字数
20%
删除比例
0
关键信息损失
他说:"没少什么。"
冗余不是"写得不好",是"写得太好"——你太想照顾读者了,所以每个地方都多说两句。

四种冗余的真实面目

❶ 客套话
❌ 原文(82字)
"为了给您提供更好的使用体验,我们推出了全新的导出功能,让您可以更加便捷地将数据导出为多种格式……"
✅ 改写(18字)
"本指南说明如何将数据导出为CSV或Excel文件。"
❷ 重复引言
"如前所述,配置数据源需要先获取令牌。在本章中,我们将详细说明令牌的刷新流程……""如前所述"就是冗余的信号。读者读了上一章,不需要你重复;没读上一章的,重复帮不了他,应该放链接让他回去看。
❸ 显而易见的说明
"点击确定按钮以确认操作"——按钮上写着"确定",读者知道点了就是确认。一篇文档里这种东西多了,读者会养成跳读习惯,真正重要的信息反而被跳过去了。
❹ 过度转折词
"然而"、"值得注意的是"——出现一次是强调,出现五次就是噪音。我审过一篇1500字的文档,"值得注意的是"出现了4次。删掉3次,留1次用在对的地方,语气反而更有力。

删减测试三步法

1 把文档复制一份,在副本上操作。
2 逐段问三个问题:这段删了,读者能完成操作吗?会理解错吗?会漏掉关键信息吗?三个都是"否",删。
3 把删减后的版本放一边,隔一天再看。那些有用的,删了你第二天就会觉得缺了什么。

真实删减前后:153字 vs 35字

原文(153字)
"在开始使用数据导出功能之前,我们需要先了解一些基本概念。数据导出是指将系统中的数据以特定格式输出到本地文件的过程。通过数据导出功能,您可以方便地将项目数据导出为CSV或Excel格式,以便在本地进行进一步的分析和处理。值得注意的是,不同的导出格式适用于不同的场景:CSV格式适合简单的数据交换,而Excel格式则更适合需要保留格式的报表场景。接下来,我们将详细介绍如何使用数据导出功能。"
删减后(35字)
"本指南说明如何将项目数据导出为CSV或Excel文件。CSV适合数据交换,Excel适合保留格式的报表。"
一句话记住这篇
删掉20%是帮读者省20%的时间
📖 下一篇预告
前提条件藏在步骤里,是最坑的惊喜
本文由 AI 协助整理润色
更多技术文档写作干货
文档不头疼
👆 欢迎关注公众号
#文档不头疼#Carly聊技术写作#技术传播#文档写作#技术写作#写作冗余#精简写作