本文介绍了提升技术写作水平的10个技巧,包括了解受众、简化语言、使用图像等,以帮助作者更有效地传达复杂信息。
好的技术写作是情人眼里出西施,至少他们是这么说的。但现实是,我们都知道什么是美好,但我们常常会感到失望。
优秀的技术写作很难找到,因为大多数要么过于复杂、冗长,要么只是缺乏良好的基本语法。找到值得阅读的资源确实非常困难,其实通过一些简单的调整,一篇普通的技术文章就可以变成一篇伟大的文章。
以下是您应该考虑提高自己的技术写作水平的 10 个技巧:
1. 了解您的受众可能已经知道的内容
当您撰写信息或教育目的时,了解您的受众对您的主题已经了解多少至关重要 - 特别是在讨论技术主题领域时。如果观众没有基本的理解,那么解释一个主题的内部运作是没有用的。这相当于在教数字之前尝试教乘法,观众不可能跟上,因为他们没有理解你所说的内容。在欣赏听众的知识和能力的情况下,您可以以某种方式教育他们,帮助他们奠定欣赏您的智慧所需的基础。
2. 考虑如何呈现你的信息
这可能是陈词滥调,但当涉及到传递高度技术性的信息时,你说的方式和你说的内容同样重要。当主题有些复杂时,通常很难与观众建立互动。因此,考虑到这一点,值得考虑您的受众希望如何参与您必须分享的信息。您可以做的越多,使您提供的知识具有吸引力,您的产出的价值就越大。
3.拥抱支持性图像
这可能有点明显,但现代读者的注意力比以往任何时候都短,因此您需要使用各种资源来参与其中。通过在你的写作中加入图像,你不仅可以用不同的东西来打破你的文案,这有助于提高流畅性并避免没有吸引力的文本块,而且你还可以与那些不能很好地与书面文字联系起来的人互动。您的许多观众可能都是视觉思考者,因此为这些人提供精彩的赞美图像是很有意义的。
4.抓住一切机会简化语言
技术写作是一种艺术形式,很容易使你所说的内容变得过于复杂,只是因为你可以。然而,当您的目标是帮助您的受众理解特定的系统、流程或概念时,值得尝试控制您的技术创造力。许多技术写作中的一个常见陷阱是,在撰写时没有考虑到读者可能不太熟悉所讨论的主题。往往无法容纳这些观众,在某些情况下,这些人实际上可能是大多数。你的写作和智慧的进入门槛越低,对所有参与者来说就越好。请记住,解释复杂事物的最短、最简单的方法通常是最好的。
5. 明确读者将从你的内容中得到什么
在内容的早期阶段概述您的写作将涵盖的内容,可确保读者准确理解您的内容的期望。这对于设定和实现期望很重要。您不想浪费读者的时间,如果他们正在寻找特定的信息,那么在开始时提供您所涵盖内容的摘要将帮助他们准确找到他们正在寻找的内容。优秀的技术写作可以在读者需要的时候为他们提供他们想要的东西。
6.不要把自己太当回事
大多数技术写作都涉及严肃的问题,但这并不意味着一切都必须认真对待,以至于没有机智或幽默的空间。有时,需要对技术主题进行修饰才能真正吸引观众,退后一步并享受该主题的乐趣是一个很好的方法。请记住,您编写的技术内容是为了人们会阅读它,而在理想的世界中,信息应该足够,但情况通常并非如此。激励读者利用一切机会参与以获得最大影响。
7. 避免引用时间敏感的信息
最好的内容仍然具有长期相关性,因此您需要确保尽可能避免提及年份,像“2019 年”和“今年”这样的短语会很快使您的内容过时,并随着时间的推移降低其有效性和价值。您希望尽可能让您的写作面向未来!如果你需要提及一个时间段,请尝试用“过去 5 年”或“过去十年”之类的短语进行概括——这些不太具体的引用仍然可以为你的论点提供时间参考,而不会牺牲其长期价值。
记录、存储和共享技术手册变得简单。
8. 分析竞争对手的内容以获取指导
看看什么对您的竞争对手有效。看看他们如何吸引人,并为自己争取最好的部分。偷偷了解竞争对手如何讨论技术主题并不可耻,事实上,有时这是确定您当前的写作相对而言有多好以及可以改进的地方的最佳方式。不要害怕接受其他技术写作文章来改进自己的文章。
9. 随着时间的推移修改和更新你的内容
技术世界瞬息万变,因此相应地更新您的内容是有意义的。如果您经常看到特定作品的流量,那么保持它们的新鲜度符合您的利益,这样您的观众就能获得最大的价值。这可以优化你的写作潜力,并确保它反映当前的工作状态。
10. 在发布之前让第三方阅读和重写
我们将用一个简单易行的技巧来结束,它几乎适用于所有写作,但可以说在技术领域比任何其他领域都更重要。永远记住让某人阅读和审查你写的所有内容,这个人应该寻找语法错误,最好进行事实检查,以确保你所做的陈述有意义且准确。第三方可以接收到的信息真是令人惊讶——如果你能避免它,就不要对你自己的写作进行质量检查。
让我们不拐弯抹角,好的技术写作很难实现,而且通常非常罕见,但是有了这些技巧,您可以将您的写作提升到一个新的水平,并真正最大限度地提高受众从您的输出中获得的价值。
最后
Baklib 是业界首创的营销操作系统和领先的数字体验平台。它通过单一统一的工作流程为整个营销生命周期(从规划到分析以及其间的一切)提供支持,并通过精心嵌入的 AI 加速流程的每一步。Baklib 是完全可组合的,为组织提供设计满足其独特需求的系统所需的灵活性,并且它也是专门构建的,为营销团队提供优雅、易于使用和无缝集成的套件的简单性。当所有这些结合在一起时,Baklib 可帮助世界上最现代的品牌协调出色的内容,在任何渠道进行实验,个性化有意义的接触点,并从每次互动中获利。结果如何?您的客户会喜欢更好、更快、更智能的数字体验。它是一体化的。这就是 Baklib。