技术交流的要点

技术写作是技术传播内容的写作，可应用于各种技术和专业领域，例如计算机硬件和软件、工程学、化学、航空工程、机器人学、金融、医学、消费电子产品、和生物技术。技术写作是技术传播领域最大的一个分支。

美国技术传播协会（Society for Technical Communication）将技术传播定义为各种形式的传播，它们具备以下特征：(1) 关于技术或专门的主题，例如计算机应用程序、医疗流程、或环境保护法规；(2) 使用印刷文档或技术手段进行传播，例如网页、帮助文件、或社交媒体网站；(3) 提供如何做某事的指导说明，无论任务的技术成程度如何。

技术写作人员需要具备多种技能，例如：

• 优秀的书面语言能力
• 对事物是如何工作的抱有好奇心
• 面谈技巧
• 平面设计知识
• 计划和分析能力
• 传播信息的能力
• 有逻辑地组织信息

好的技术写作要求简洁、目标明确、易于理解、没有错误、并且以读者为中心。技术写作人员应使文档尽可能表达明确、避免使用行业术语，语言风格方面应避免被动语态和名词化（即把动词、形容词转换为名词使用）。由于要应用于真实的场景，技术文档应明确文档主题是什么，以及读者应该做什么。以描述如何使用大功率 X 射线机的使用说明书为例，如果内容晦涩难懂，可能会导致严重的后果。

技术写作要求写作人员对其读者做大量研究。技术写作人员需要知道读者对所讨论内容的了解程度，因为读者的知识库将决定文档的内容和重点。例如写给一群高水平科学家的讨论某科学研究成果的评估报告，跟写给普通大众的将大不相同。技术写作人员本身不需要是主题专家 ，当某项工作需要对主题具备更多知识时，他们通常与主题专家共同协作来完成。

技术写作必须准确。在分析读者之后，技术写作人员必须知道要传达什么内容，然后以准确、适当的方式传达信息。如果写作人员表达的信息不准确，可能会造成人身伤害、环境或财产方面的损失。了解读者对保证准确性很重要，因为文档语言需要根据读者对主题的了解程度进行调整。例如编写如何正确、安全搭建书架的使用说明书，应确保任何人都可以跟着操作，而且要求精确到细节（如每个紧固件的具体位置）。如果这些说明不准确，可能会导致书架安装不稳或无法安装。

文档的设计和版面也是技术写作非常重要的组成部分。技术写作人员在文档的可读性上投入大量时间，因为设计糟糕的文档会妨碍读者对内容的理解。恰当使用文档设计元素对技术文档尤其重要，如项目符号、字体大小、和粗体。技术写作人员经常使用图片、图表和视频，因为对于传达复杂的信息（例如公司的年度收益或产品的设计特性），这些媒体元素远远比文字描述要有效的多。