编写技术指南时的12个惊人的提示,以吸引你的读者

Avatar of Author
Tal F.
on January 07, 2023 · · filed under Product Documentation Product Management Documentation Portals Product Updates Best Practices Technical Writing

技术写作是一项令人匪夷所思的工作,因为作者必须以可理解和清晰的方式向受众阐释高科技信息。

技术文章不应过于复杂,难以理解,也不应在语法上出现错误。而有时,要找到简单明了的好的技术指南,是一项相当繁琐的工作。

你的技术写作可以是任何形式的,比如说

  • 一份说明或用户手册

  • 培训课程书

  • 产品说明

  • 白皮书

  • 产品手册

  • 参考指南

  • 年度报告,以及更多

在这个快速发展的数字时代,技术作家必须利用某些策略来完成对读者的真正参与。的确,这是一个巨大的挑战!

因此,在这篇文章中,我们将为您提供一些惊人的技巧和窍门,以便在编写技术指南时吸引读者:

技术作家的主要目标

1.了解听众

分析目标受众,相应地,技术作家必须决定其写作的风格、语气、长度和格式。

如果不了解受众的角色,你可能最终写出过于简单或过于复杂的技术文章。而且,我们不希望这样做。

人们必须尝试在有洞察力的、有知识的和可理解的信息传递之间取得完美的平衡。

2.可读性

可读性是吸引你的技术读者的关键因素之一,因为可读性的分数是决定你的文章到底有多大的可读性。读者绝不能觉得很难浏览你的技术指南或掌握所使用的语言水平。

撰稿人必须尝试用最佳的风格和格式来灌输用户友好的语言,使其内容丰富而简单。

3.精确性

文件中的统计数据、事实和主张必须始终经过交叉检查,并有可靠来源的证据或研究报告的支持。否则,所提供的信息可能在公众中失去其真实性和可靠性。

为了实现上述目标,技术作家必须利用以下策略:

  • 以简单、清晰的方式传达技术信息,这样即使是非技术性的受众也能理解。

  • 使用技术和工具来磨练所提供的技术内容。

  • 有效地将技术建议、想法、概念、观点和意见按战略顺序排列。

*用正确的语气词汇与精确的结构来说明报告、文件或演示。

写作技术指南时应用的12个最佳提示,以吸引你的读者

1.分析你的听众的专业知识

技术指南必须是信息丰富和有洞察力的。在撰写此类内容时,作者需要分析受众对与该主题相关的技术概念已经了解多少。

没有必要去解释你的听众已经精通的主题。同样的道理,跳过你的听众可能没有基本了解的概念也是不合逻辑的。两种情况下,你的听众都有可能失去兴趣,或者发现你的技术指南要么太复杂,要么不必要地啰嗦。

这里的关键是分析你的听众的基础知识和能力,然后为他们提供信息,以建立一个关于该主题的坚实基础,同时具有教育意义。

2.深入研究

写作技术内容需要全面的研究和准确的信息,并以正确的统计数据或事实为支撑。这就是赋予你的技术内容的重量和价值;因此,它是吸引你的读者的最关键因素。

对背景和技术信息进行详细的分析,例如:

  • 收集与该主题的所有技术方面有关的信息,包括范围、特点、设计过程、规格、法律框架等。

  • 研究法律合同及其要求。技术内容必须符合适用的监管标准。因此,要确保与法律要求保持一致。

  • 分析目标受众,并根据目标用户群的理解和要求来定制你的内容。这包括各方面,如图形、语言水平、输出媒体类型、可读性、复杂程度等。

3.表达的结构

在以指南或手册的形式传授技术知识时,结构和格式起着至关重要的作用。

技术指南由于有点复杂,难以理解;因此你不想在结构中灌输更多的复杂性。培养对这些内容的参与度变得很困难。

为了向你的受众提供价值,作者必须考虑如何以他们希望的方式来组织内容。

4.视觉和图形

使用在视觉上有吸引力但信息量大的技术相关图片,不仅可以在战术上打破内容,还可以吸引你的读者。

当今读者的注意力似乎很短。因此,带有图片的技术指南将使你的内容更容易浏览,而且流畅,帮助你打破冗长的文字块。

同样地,不要过多地使用图片,因为它可能会掩盖你的实际技术信息。尝试在文本和视觉表现之间取得良好的平衡。

5.例子是必须的

例子有可能使复杂的主题更容易理解。阐明一个与图片中的主题产生共鸣的实时场景,使你的受众更有效地理解它。技术作家甚至可以用图像作为例子,然后加以解释。

6.正确发声

很多时候,技术指南听起来很平凡,语气也很中性,这不应该是这样的。你的技术指南必须有自己的声音,而灌输这种声音的最好方法之一是使用第一人称视角。

当用第一人称写作时,要确保仍然保持权威和专业的方法。

7.始终使用简单的语言

技术写作不应该是复杂的,只是因为它涵盖了高科技的主题。当试图确定技术概念、流程或方法时,要尽量跟上技术的创造性,而不要过度复杂化。

导致灾难性写作的最常见的罪魁祸首之一是没有考虑到读者可能不精通某些概念的事实。有了这一点,你的听众很可能会感到困惑,不适应,而且参与度较低。

简单技术英语(STE)标准将提高你文件的可译性和可读性。

试着用以下规则来写一份技术指南:

  • 简单的句子结构

*主动语态

*一致的术语

  • 简单的动词时态

换句话说,尽量保持简单和简短。

8.明确钩子

在你的技术指南的开头,确定你内容的钩子,即读者将从你的指南中学到的东西。迅速勾勒出技术内容,并解释你的文章将要涉及的所有领域,这样你的读者就会知道要期待什么。

这样做将确保你的读者在结束阅读整个指南后感到满意和满足。没有人希望读完一整块内容后,最后才发现这不是他们要找的信息。

9.版面设计是必不可少的

布局是使你的技术内容更有吸引力和可读性的有效方法之一,同时要集中在关键领域。

要战略性地使用分页符、项目要点、编号列表、黑体关键词和表格,以突出重要的内容,并将注意力引向正确的部分。

10.避免提及特定的时间段

为了使你的技术内容长期有效,确保你不提及具体年份,如 "2021年 "或 "今年"。使用这些短语会将你的内容限制在一个特定的时间段,并降低其长期的有效性。

通过不使用时间敏感的参考,来证明你的内容是未来的;而是尽量使其具有一般性。

11.使之诙谐

即使是技术性的内容,也要尝试添加一些幽默或诙谐,使其变得轻巧。这是最简单和最有效的方法之一,可以吸引你的观众。

12.审查你的技术文件

从主题专家(SME)那里审查一次你的技术文件,以验证你的内容,这始终是一个明智的步骤。这不仅可以为你提供宝贵的见解,还可以使其没有语法错误。

结语

至此,我们结束了关于写技术指南时如何吸引读者的创意文章。最后但并非最不重要;确保你总是用正确的信息来源来支持你的主张和事实,如统计数据、报告、研究论文等。

此外,一旦你完成了,就修改你的技术文件,确保它是清晰、准确和最新的。这就是全部!


Subscribe to the newsletter

Stay up to date with our latest news and products