如何提高你的技术写作技能?
How to improve your technical writing skills?

什么是技术写作?

技术写作是一种针对特定主题的写作形式,需要提供指导、说明或解释。这种写作风格具有独特的目的,因此与创意写作、学术写作或商业写作等其他类型的写作有着截然不同的特点。它是一种专注于将复杂信息传达给需要完成特定任务或达成特定目标的人的写作学科。技术写作通常被描述为 “化繁为简” 因此。它也是技术传播的一个分支,主要应用于数字技术、工程、科学、航空、机器人、金融、医学、电子、林业和生物技术等技术和操作领域。

图片来源:@尼克·莫里森

技术写作的主要类型有哪些?

技术报告
除了说明和指导外,许多产品还会提供有关产品开发、结构变化和运行变化的详细信息。为了确保准确性和清晰性,技术写作者会组织和编辑这些材料。

规则与条例
各种规模的企业都需要制定政策和程序,以明确管理企业的规则。他们还利用员工手册来保护自己免受员工提起的诉讼,这些员工声称自己并不知晓某些规则和条例。

商业计划
金融机构在向初创企业或已成立的公司提供贷款前,需要一份详尽的商业策略。这些文件需要进行广泛而高度专业的研究,并深入理解公司的财务和运营状况,包括支出预测、潜在损失和利润率。它们还要求进行竞争分析、营销策略,以及对所有者职业背景和财务状况的深入背景资料。

文献综述
文献综述可以包含在更大的报告中,也可以作为独立的文档使用。它是一种技术写作,用于列举某一主题当前的知识状况。文献综述会突出显示研究里程碑、相互矛盾的发现,以及需要通过进一步研究来了解的内容,同时也会总结和解释某一主题上以往的研究和发现。

用户使用指南
当你购买软件、安装计算机组件或购买这些产品之一时,通常会附带一份用户手册,说明如何使用数字设备或消费类电器。这些被称为最终用户指南,但这一类别还包括故障排除手册、组装说明、“注意事项”、保修信息和法律免责声明等文件。

我们如何提高技术写作技能?

  1. 制定大纲
    为了帮助你了解在工作中需要涵盖的内容,我们建议你制定一个大纲。在进行研究时,这也有助于发现知识盲点。当撰写白皮书或案例研究等长篇内容时,大纲可以作为提醒,帮助你记住需要涵盖的内容。也可以使用模板代替大纲。例如,商业计划书遵循某些行业公认的标准,包括执行摘要和竞争分析等要素。
  2. 优先考虑可读性
    技术写作不是创意写作,因为它旨在指导而非启发或娱乐。在撰写复杂主题时,使你的作品更易阅读会有所帮助。
  3. 了解你的受众
    理解你的受众至关重要,尤其是在撰写技术信息时。你可以根据预期阅读你文章的受众,调整自己的词汇、语气和表达方式。
  4. 包含图片
  5. 在技术写作中包含图片更像是一种必要条件而非奢侈。插图、图片和流程图可以为文字密集的文本注入一些急需的轻松感。

了解更多信息……

阅读以下书籍,了解更多关于技术写作的内容!