作为一名帮助工程师撰写博客文章的技术内容作家，我最近完成了 Google 的技术写作课程。虽然本课程的主要目的是协助工程师撰写技术文档，但我发现其中一些建议也适用于工程博客。
通过实施本课程中教授的原则，工程师可以改进他们的博客文章，使其更易于访问并吸引受众。他们将能够更好地传达他们的想法和概念，并提高他们的整体知名度。
在这里，我将详细介绍我在工程博客方面发现的最有用的建议。
简短的演示
为了让您了解 Google 技术写作课程所提供的内容，我们首先将建议应用到一篇短文中。
请考虑以下技术博客文章摘录，使用从课程中收集到的提示进行修改……
原来的： “这本应是一个令人兴奋的项目。但开发团队和产品团队在讨论新的 ANN 时遇到了问题。他们意识到文档不足，这让他们很难理解其功能。还注意到对系统可扩展性的担忧；需要进一步测试以确保所有组件无缝协作。此外，团队中的角色和职责也不够明确。”
增强型： “开发团队和产品团队在讨论新的人工神经网络 (ANN) 时面临挑战。开发团队意识到不完整的文档妨碍了他们对其功能的理解。系统可扩展性也引起了担忧。需要进行大量测试以确保所有组件无缝集成。此外，团队角色和职责仍然存在模糊性。”
你信服了吗？
我们来逐一回顾一下对原文所做的改进：
-
缩写用法：原文中，缩写 “安妮” 在没有事先介绍其完整形式的情况下使用， “人工神经网络。” 因此，在增强版本中，我们写出了完整术语，后面跟着首字母缩略词。
-
歧义代词：代词 “他们” 可以指开发团队或产品团队。在增强文本中， “他们” 被替换为 “开发团队” 提供清晰度并确保读者了解所指的是谁。
-
主动语态：原文包含被动语态结构，这会使句子缺乏吸引力和直接性。因此 “人们还担心该系统的可扩展性” 被替换为 “人们对系统可扩展性的担忧也随之而来。”
-
有/有：用法 “有” 句子结构已被减少，以使句子更具吸引力。
-
开头句实力：原文的开头句不够清晰，不能有效地确立段落的中心思想。
-
原文中的分号使用不正确，因为它分隔了两个独立的想法。增强文本中用句号代替了分号。
-
风格指南的一致性： “人工神经网络” 在增强文本中以小写形式书写以遵循 Google 风格指南，该指南倾向于将非专有名词的术语使用小写形式。
话虽如此，如果您有几分钟的时间与我交流，我很乐意更详细地回顾每一条建议……
正确使用首字母缩略词
当在文章中第一次使用不熟悉的缩写词时，请写出完整术语，然后在括号中写出缩写词。此后，您可以单独使用缩写词。
例如：
“本手册适用于刚接触人工神经网络（ANN）的研究人员或需要通过编程脚本优化 ANN 参数的研究人员。”
但你应该系统地使用首字母缩略词吗？
当然，缩略词可以缩短句子，但它们会增加一层抽象，要求读者在心理上将其扩展为完整形式，这可能需要更长的时间来处理。
在决定是否使用首字母缩略词时，请考虑以下规则：
-
首字母缩略词是否比完整术语短得多？
-
文章中是否多次引用该首字母缩略词？
-
这个首字母缩略词是否与主题相关？
另一方面，请记住，拼写缩写并不总是能帮助读者理解它。如果你写出 “便携式文档格式” 代替 “PDF”， 读者不会明白它是什么。换句话说，并非所有的首字母缩略词都应该拼写出来。
避免使用模棱两可的代词
模棱两可的代词会在技术写作中造成混淆，因为它们可能指代多个先行词，或者不清楚它们所指代的内容。
例如，考虑这个句子： “当工程师与开发商交谈时，他们解释了这个问题。” 目前还不清楚 “他们” 指工程师或者开发商。
以下是代词使用的一些准则：
-
仅在引入名词后才使用代词。
-
确保代词尽可能靠近相应的名词。如果名词和代词相隔超过五个单词，请考虑重复名词。
-
每当在名词和代词之间引入第二个名词时，请使用名词而不是代词。
选择主动语态而不是被动语态
尽量使用主动语态。谨慎使用被动语态。
主动语态有以下优点：
-
大多数读者在心里将被动语态转换成主动语态。
-
被动语态会掩盖你的想法。
-
使用被动语态的句子有时会完全忽略行为者，让读者猜测他们是谁。
-
一般来说，主动语态的句子比被动语态的句子短。
减少使用“有”的次数
以 开头的句子 “有” 或者 “有” 将通用名词与通用动词组合在一起，这无法吸引读者。为读者提供实际的主语和动词。
另外，您也可以直接删除 “有” 或者 “有” （以及句子后面的另外一两个单词）。
例如，考虑以下句子……
原来的： “理论和实践之间存在很大差异。”
增强型： “理论和实践之间存在显著差异。”
在其他情况下，以 “有” 或者 “有” 避免了创建真实主语或动词的麻烦。用有意义的主语替换它们可以为读者带来更清晰的体验。
原来的： “不保证按时间顺序接收更新。”
增强型： “客户可能不会按时间顺序收到更新。”
为段落写一个强有力的开头句
开头句是段落中最重要的句子之一。忙碌的读者往往会专注于开头句，而忽略后面的内容。段落的中心思想应该在开头句中确立。
原来的： “代码块是同一函数内的任何一组连续代码。例如，假设您编写了一个代码块，用于检测输入行是否以句点结尾。要评估一百万行输入，请创建一个运行一百万次的循环。”
增强型： “循环多次运行相同的代码块。例如，假设您编写了一个代码块来检测输入行是否以句点结尾。要评估一百万行输入，请创建一个运行一百万次的循环。”
适当使用标点符号
期间
句号用于分隔独立的思想。
例子： “工程师们完成了桥梁的结构分析。然后他们开始最终确定详细的设计方案。”
逗号
逗号表示句子各部分之间的停顿。
例子：
-
列表中的项目： “我们需要购买服务器、存储设备和网线。”
-
引言： “在分析了数据之后，我们做出了决定。”
-
非必要信息： “我们的软件是开源的，具有高度可定制性。”
分号
分号连接紧密相关的独立子句。
例子： “应用程序崩溃；服务器需要重新启动。”
需要注意的是：分号前后的想法都必须是语法完整的句子。
破折号
破折号表示比逗号更长的停顿。
例子： “新功能虽然并不完美，但显著改善了用户体验。”
括号
括号内是一些与主要观点无关的补充信息或题外话。
例子： “新的协议（我们进行了广泛的测试）已经实施。”
采用既定的风格指南
风格指南可确保写作的一致性，涵盖语气、术语、格式和标点符号等方面。采用风格指南有助于在所有博客文章中保持专业且连贯的语气。
样式指南的建立和维护非常耗时，因此建议采用公认的样式指南并根据需要进行修改。
针对工程类受众的热门风格指南包括：
进一步
总之，Google 的技术写作课程提供了适用于工程博客的宝贵见解。通过运用所学的原则，工程师可以提高受众参与度。
更进一步，在撰写博客文章之前，请务必了解并定义目标受众，以确保内容经过适当调整。相应地调整语言、解释深度和内容结构可确保您的信息清晰且相关。因此，在写作之前，请务必问自己：我的主要受众是谁？他们对这个主题的了解程度如何？他们需要知道什么信息？我如何以一种引人入胜且易于理解的方式呈现这些信息？
如果您想通过其他技巧来提高您的技术写作水平，请随时咨询 Google 技术写作课程！
