技术写作指南 | 承：写作“像滑动玻璃门”一样干净利索

二、写作“像滑动玻璃门”一样干净利索

想象一下你的话像一扇滑动玻璃门。现在脑补一下：撞向玻璃门——贼硬。

这就是你的写作应该多干净：干净的要命。

查看这个产品说明。

产品说明

• 该产品专为***(blank)** *使用而设计。
• 该产品具有的功能包括***(blank)** *。
• 该产品可在***(blank)** *处获得。

你懂了吗？

不，你没有。

原因就是，产品说明太模糊了。不清楚该产品是什么，它的功能是什么，甚至在哪里可以买到它。

清楚的技术写作从简单的明确开始。清晰意味着什么？这里有一个清晰的句子：

清晰的句子

该产品是一个用于将数据从一种格式转换为另一种格式的软件。

它简短而直截了当，不是吗？你应该能够直接进入核心要义，而不是费力地从一堆无关紧要的信息中寻找重点。

不要害怕重复。重复可以帮助读者记住你的要点。

重复的例子

该产品专为小型企业而设计，能够满足小型企业的独特需求。

你看，重复“小型企业”帮助我们强调了该产品专为小型企业而设计。

不要害怕成为无聊的人。无聊比困惑要好得多。

无聊的例子

该产品非常易于使用，即使是初学者也能轻松掌握。

你看，使用“非常”和“轻松”这样的词语并不会让你的写作更有趣，只会让它更模糊。

有趣的例子

该产品就像一个任劳任怨的助手，能够帮助你完成任务。

你看，使用比喻可以使你的写作更生动、有趣。但不要滥用比喻，否则会分散读者的注意力。

注意你的语气。你的语气应该与你的受众相一致。

语气示例

• 对技术受众：该产品专为满足您的技术需求而设计。
• 对非技术受众：该产品非常易于使用，即使您不懂技术知识也能轻松上手。

请注意，我们是如何根据受众的不同来调整语气的。

使用主动语态。主动语态比被动语态更直接、更有力。

主动语态示例

• 该产品可以轻松满足您的需求。
• 该产品已在多家公司中得到广泛使用。

你看，主动语态使句子更加有力，不是吗？

请勿使用行话。行话只会让你的写作晦涩难懂。

行话示例

• 该产品采用了最先进的技术。

你看，使用“最先进”这样的行话并不能让你的写作更专业，只会让它更难懂。

清晰的示例

• 该产品使用了最新的技术。

你看，使用“最新”这样的词语更清晰、易懂。

避免使用长句。长句会让你的写作难以理解。

长句示例

• 该产品专为满足您在数据转换方面的需求而设计，能够帮助您轻松地将数据从一种格式转换为另一种格式。

你看，这个句子太长了，很难理解。

短句示例

• 该产品可以轻松地将数据从一种格式转换为另一种格式。
• 该产品专为满足您的数据转换需求而设计。

你看，将长句分成短句更容易理解，不是吗？

请勿使用缩写。缩写会让你的写作难以理解。

缩写示例

• 该产品兼容多种操作系统，包括 Windows、Mac 和 Linux。

你看，使用“Windows、Mac 和 Linux”这样的缩写会让你的写作难以理解。

清晰的示例

• 该产品兼容多种操作系统，包括微软 Windows、苹果 Mac 和 Linux。

你看，使用全称可以让你的写作更清晰、易懂。

请勿使用感叹号。感叹号会让你的写作显得不专业。

使用感叹号的示例

• 该产品非常好用！

你看，使用感叹号会让你的写作显得不专业。

不使用感叹号的示例

• 该产品非常好用。

你看，不使用感叹号可以使你的写作更专业。

总之，写作的唯一真正目的是把信息清晰地传达给读者。如果你做到了这一点，你就是一位优秀的作家。如果你没有做到这一点，你就是一位糟糕的作家。就是这样。