谷歌为工程博客提供技术写作课程的经验教训
作为一名帮助工程师撰写博客文章的技术内容作家，我最近完成了 Google 的技术写作课程。虽然本课程的主要目的是协助工程师撰写技术文档，但我发现其中一些建议也适用于工程博客。 通过实施本课程中教授的原则，工程师可以改进他们的博客文章，使其更易于访问并吸引受众。他们将能够更好地传达他们的想法和概念，并提高他们的整体知名度。 在这里，我将详细介绍我在工程博客方面发现的最有用的建议。 简短的演示 为了让您了解 Google 技术写作课程所提供的内容，我们首先将建议应用到一篇短文中。 请考虑以下技术博客文章摘录，使用从课程中收集到的提示进行修改…… 原来的： “这本应是一个令人兴奋的项目。但开发团队和产品团队在讨论新的 ANN 时遇到了问题。他们意识到文档不足，这让他们很难理解其功能。还注意到对系统可扩展性的担忧；需要进一步测试以确保所有组件无缝协作。此外，团队中的角色和职责也不够明确。” 增强型： “开发团队和产品团队在讨论新的人工神经网络 (ANN) 时面临挑战。开发团队意识到不完整的文档妨碍了他们对其功能的理解。系统可扩展性也引起了担忧。需要进行大量测试以确保所有组件无缝集成。此外，团队角色和职责仍然存在模糊性。” 你信服了吗？ 我们来逐一回顾一下对原文所做的改进： 缩写用法：原文中，缩写 “安妮” 在没有事先介绍其完整形式的情况下使用， “人工神经网络。” 因此，在增强版本中，我们写出了完整术语，后面跟着首字母缩略词。 歧义代词：代词 “他们” 可以指开发团队或产品团队。在增强文本中， “他们” 被替换为 “开发团队” 提供清晰度并确保读者了解所指的是谁。 主动语态：原文包含被动语态结构，这会使句子缺乏吸引力和直接性。因此 “人们还担心该系统的可扩展性” 被替换为 “人们对系统可扩展性的担忧也随之而来。” 有/有：用法 “有” 句子结构已被减少，以使句子更具吸引力。 开头句实力：原文的开头句不够清晰，不能有效地确立段落的中心思想。 原文中的分号使用不正确，因为它分隔了两个独立的想法。增强文本中用句号代替了分号。 风格指南的一致性： “人工神经网络” 在增强文本中以小写形式书写以遵循 Google 风格指南，该指南倾向于将非专有名词的术语使用小写形式。 话虽如此，如果您有几分钟的时间与我交流，我很乐意更详细地回顾每一条建议…… 正确使用首字母缩略词 当在文章中第一次使用不熟悉的缩写词时，请写出完整术语，然后在括号中写出缩写词。此后，您可以单独使用缩写词。 例如：“本手册适用于刚接触人工神经网络（ANN）的研究人员或需要通过编程脚本优化 ANN 参数的研究人员。” 但你应该系统地使用首字母缩略词吗？ 当然，缩略词可以缩短句子，但它们会增加一层抽象，要求读者在心理上将其扩展为完整形式，这可能需要更长的时间来处理。 在决定是否使用首字母缩略词时，请考虑以下规则： […]