HTML、CSS、JavaScript、Python、PHP、C++、Dart--有这么多的编程语言，你甚至可能完全精通其中的几种。但是，随着我们的目标是写出更多、更好的代码，我们用日常语言写作和交流的方式变得越来越重要......甚至可能被忽略了。
我们编写和讨论代码的方式可以说与代码本身同样重要。尽管你可能在这个问题上持不同观点，但我们都可以同意，我们的言辞既会提高代码的有效性，也会损害代码的有效性。
在这篇文章中，我想概述一下这两个看似截然不同的领域--编程和写作--如何能够结合起来，将我们的开发技能提升到一个新的水平。
等等，技术写作？是的你没看错。我真的相信我们在某种意义上都是作家。我会在这里给你介绍写作技巧、建议以及例子，使你成为更好的开发者和沟通者。
本文包括以下部分：
- 技术写作无处不在
- 什么才是好语法？
- 编写代码注释
- 编写pull request
- 报告bug
- 与客户沟通
- 编写微文案
- 编写无障碍标记
- 总结
技术写作无处不在
2021年，流行的Mac Git客户端Tower背后的团队对4000多名开发者进行了调查，发现他们中近50%的人每天花3-6个小时来编写代码。
是的，这是一个针对特定小众群体的调查，但我想我们中的很多人都在这个范围内。无论如何，开发者并非7 * 24都在编写代码，因为正如这个调查所显示的，我们花了很多时间在做其他事情。
这可能包括以下事情：
- 演示一个新功能，
- 记录这个新功能，
- 更新与这个新功能相关的工作计划，或者
- 将支持这个新功能的工作积压。
当然，总是有时间上厕所和玩Wordle游戏的。
无论如何，我们通常所做的大部分事情都涉及与团队、同事、客户、用户以及其他开发者等人沟通。
所以我们确实花了很多时间通过文字与人类交流，除了通过代码与计算机交流之外。文字是书面语言。如果我们能更好地书写文字，我们就能更好地交流。当我们更好地交流时，我们就更有可能得到我们想要的。
而且这还不是全部。一些程序员还喜欢制作他们自己的产品，这意味着他们需要将市场营销作为工作的一部分。技术写作在这方面也起着重要作用。所以没错，我可以非常公正地说，技术写作确实无处不在。
什么才是好语法？
有这么多的编程语言，我们最不想做的就是学习另一种语言。
语法是英语的一个重要组成部分，它释放了沟通的全部潜力。它使我们更加正式、专业和连贯。
让我给你简要介绍一下语言。
英语语法
正如编程语言，英语有一个明确的语法，它从单词开始。
单词是英语的组成部分，它们可分为八个类别：
-
名词（Nouns）。这些可以是人名、动物、地点、概念和物体的名称。
- CSS 是前端开发的核心语言之一。
-
动词（Verbs）。动词传达动作。即使“is”也可以被视为一种动作。
- 玛西娅早上编写代码，下午回复电子邮件。
-
形容词（Adjectives）。形容词是我们描述名词的方式。它们就像元数据，为句子增添更多细节，描绘出生动的画面。
- CSS是一种优雅而富有诗意的语言。
- HTML表格是复杂而繁琐的。
- 盒模型对于理解CSS很重要。
-
介词（Prepositions）。介词在名词和其他单词之间建立关系，通常表示方向、时间、地点和空间。
- 你将你的工作提交到仓库了吗？
- 对于这个组件，最好的方法是什么？
- 我们与真实用户进行了访谈。
-
副词（Adverbs）。有时候需要更具体的动作描述，因此我们使用副词，比如“跑得快”和“编译慢”。它们通常以“-ly”结尾。
- 这绝对是所有想法中最好的。
- 奇普耐心地等待戴尔的反馈。
- 团队在项目上勤奋地工作。
-
连词（Conjunctions）。连词连接句子中的短语。
- CSS用于样式设计，而HTML用于标记。
- 是的，我编写代码，但我也从事设计工作。
- 那修复了这个漏洞。然而它又引入了一个新的漏洞。
-
过渡词（Transitions）。段落由相互连接的句子组成，这些句子使用过渡词来连接。
- 有很多编程语言。然而，只有少数被应用于网络行业。
- 首先，克隆该目录。
- 我喜欢这种方法，但另一方面，我也知道另一种方法。
-
代词（Pronouns）。当名词重复出现时，我们会用代词来代替，比如“他”，“它”和“那个”。
- CSS是一种样式表语言。我们使用它来为网站添加样式。
- 托尼热爱编码，他每天练习。
- 我们的客户精通技术，因为他们了解代码。
将这些语言元素看作UI组件：它们是模块化的部分，你可以移动它们以构建完整而健壮的句子，就像你可能会组装完整而健壮的UI一样。所有组件是否始终需要存在？当然不需要！使用所需的部分组装句子，就像你使用界面一样来完成体验。
语气和语调
词汇、标点符号、句子结构和单词选择。这些都是英语的组成要素。我们用它们来分享想法，与朋友和家人交流，并给同事发送电子邮件。
但考虑我们信息的声音是至关重要的。一个感叹号就能完全改变信息的语气，这很神奇：