技术写作是技术传播内容的写作，可应用于各种技术和专业领域，例如计算机硬件和软件、工程学、化学、航空工程、机器人学、金融、医学、消费电子产品、和生物技术。技术写作是技术传播领域最大的一个分支。
美国技术传播协会（Society for Technical Communication）将技术传播定义为各种形式的传播，它们具备以下特征：(1) 关于技术或专门的主题，例如计算机应用程序、医疗流程、或环境保护法规；(2) 使用印刷文档或技术手段进行传播，例如网页、帮助文件、或社交媒体网站；(3) 提供如何做某事的指导说明，无论任务的技术成程度如何。
概述
技术写作由技术写作人员（或技术资料编写者）完成、是一个在专业场所编写和共享信息的过程。技术写作人员的首要任务是以最明确、有效的方式将信息（通常是复杂的信息）传达给另一个人或另一方。
虽然通常跟在线帮助和用户手册联系在一起，技术写作涵盖多种文档类型和技术手段。新闻稿、备忘录、商业计划书、数据手册、产品描述和设计规范、白皮书、个人简历、和工作申请函，这些只是技术写作中的一小部分。
发展历史
虽然技术写作在第二次世界大战后才被公认为是一个正式的职业，但它的起源可追溯到古典时期。评论家们认为，亚里士多德等作家的作品是最早的技术写作形式。
随着机械式印刷机的发明、文艺复兴开始、以及启蒙时代的兴起，用文件记录研究结果变成一个必然需求。艾萨克·牛顿和列奥纳多·达·芬奇等科学家和发明家纷纷用文档记录了他们的发明和研究结果。随着新机器的发明和使用，指导人们使用这些越来越复杂的机器的需求不断增加。
1947 年晶体管的发现使计算机的制造成本比以往任何时候都要低。
- 优秀的书面语言能力
- 对事物是如何工作的抱有好奇心
- 面谈技巧
- 平面设计知识
- 计划和分析能力
- 传播信息的能力
- 有逻辑地组织信息
好的技术写作要求简洁、目标明确、易于理解、没有错误、并且以读者为中心。技术写作人员应使文档尽可能表达明确、避免使用行业术语，语言风格方面应避免被动语态和名词化（即把动词、形容词转换为名词使用）。
文档的设计和版面也是技术写作非常重要的组成部分。技术写作人员经常使用图片、图表和视频，因为对于传达复杂的信息（例如公司的年度收益或产品的设计特性），这些媒体元素远远比文字描述要有效的多。
- 设计规范是描述某个物品的结构、组成部分、包装、和交付物的设计要点，它提供足够详细的信息以使另一方能够重建。例如，技术写作人员可能用文字和图表的方式编写某智能手机或自行车的规格书，以便制造商能够制造出该物品。
- 描述是对程序和过程的简单描述，以帮助读者理解某个事物是如何工作的。例如，某人在他/她的工作场所遇到的挑战，以及他/她是如何解决的，这就是案例研究。
- 白皮书是写给领域专家的文档，通常描述技术或商业方面的某个解决方案。
- 数据手册是关于产品、机器、设备、软件、应用程序、或系统的性能、关键指标、技术特性、应用电路和其它重要信息的简要概述。
- API 指南是为开发者社区编写的用来说明应用程序接口的文档。
工具
技术写作人员使用以下工具来编写和呈现文档：
- 桌面出版工具或文字处理工具。技术写作人员使用文字处理工具（例如 Scrivener、Microsoft Word、Apple Pages、LibreOffice Writer）来编写、编辑、设计和打印文档。对于技术写作来说，页面布局跟写作语言同样重要，因此技术写作人员还使用专业的桌面排版工具（例如 Adobe InDesign 和 LyX）。 这些软件跟文字处理工具的功能相似，但提供更多文档设计的功能，并使大量排版工作自动化。
- 帮助文件制作工具被技术写作人员用来创建帮助系统。帮助文件与软件产品一起提供，可通过网页浏览器访问或以文件形式提供给用户在电脑上查看。 Madcap Flare 和 Adobe Framemaker 是常用的帮助文件制作工具。
- 绘图软件。通常，图片和其它视觉元素能够比文本段落更好地描绘信息。
- 截屏工具。技术写作人员通常使用 Camtasia 和 Snagit 等截屏工具来截取桌面。
参见
- 广告文案写作
- 非虚构写作
- 编辑
- 教学设计
- 技术传播
参考文献
外部链接
*
- [https://pcs.ieee.org/?q=node/24 IEEE Transactions on Professional Communication]
- Technical writing courses from Wikiversity
评论 (0)