我从为 SitePoint、Draft.dev 等撰稿中学到的 8 个技术写作技巧

本文最初发表于我的个人博客。

2020 年底，在断断续续地写了一些文章之后，我终于创建了这个博客。通过这个博客，我得以撰写许多关于Javascript、浏览器扩展、Magento 2等方面的文章和教程。

随后，在2021年5月，我拓展了写作领域，开始申请为不同的平台撰稿。我成功获得了一些工作机会，成为一些知名网站或机构的作者，例如SitePoint、Draft.dev、LogRocket、ContentLab等等。您可以访问“我的客座文章”页面查看部分作品。

在为这些网站或其客户撰稿之后，我学到了很多关于不同技术的知识。我还掌握了一些提升技术写作水平的技巧。在本文中，我将与大家分享其中的一些技巧，并在文末附上一些链接，方便您申请加入这些平台。

先列个提纲。

以前，我常常会想到一个适合写的文章主题或概念，然后立刻开始动笔；如果是教程，我会同时开始编写代码。但是，自从我开始为 SitePoint 撰稿后，他们总是要求我在动笔之前先提供文章大纲。Draft.dev 也一样，每次接到文章任务，都是从大纲开始的。

为文章拟定提纲有助于你在深入写作之前整理思路和想法。你可能有很多有用的知识想要分享，但它们很容易散落在零散的句子中。先列出文章的主题要点，可以帮助你规划每个想法、观点或建议的放置位置。

如果你不确定如何撰写提纲，可以参考一些教程入门。当然，你也可以先在脑海中构思文章提纲，如果这样更容易的话。花些时间规划文章的结构，一旦你对标题和思路都足够自信，就可以开始撰写文章了。

简化教程

当教程中的某个部分需要设置一些与教程主题无关的内容时，请尽可能简化。例如：假设你正在制作一个关于 Node.js 的教程。你可能需要存储数据，所以最终选择了 MySQL 作为数据库。那么，你就需要在教程中添加一些关于数据库设置的说明，而这些设置实际上与教程主题无关。

这可能会造成困惑，尤其是在读者对 MySQL（以我举的例子为例）了解不足，或者他们的电脑上根本没有安装 MySQL 服务器的情况下。务必确保你的教程简洁明了。即使某些内容在你看来很简单，对读者来说也可能是一个障碍，最终导致他们放弃你的教程，转而寻找更简单的版本。在上面的例子中，如果你需要使用某种方式来存储数据，可以尝试使用像 SQLite 数据库这样简单的方案，它不需要任何复杂的配置。即使读者对此一无所知，也无需了解这些知识就能继续阅读文章。

保持一致性

撰写文章或教程时，保持一致性至关重要。这体现在很多方面。首先，不要在文章中使用不同的拼写。例如，不要一会儿用 Javascript，一会儿又用 JavaScript。其次，确保代码的一致性。不要"时而使用 `<script>`，时而使用'`<script>`，或者在某些代码块中省略 `<script>` ;，而在其他代码块中保留。虽然这些细节看似无关紧要，但保持一致性能够使文章结构清晰、风格统一。

不要假设读者都明白。

很多时候，我们使用某些词语、短语、缩写，或者忽略一些细节，以为它们是基本常识，我们自己懂，读者也懂。但重要的是，你的文章要面向所有读者。

使用缩写时，至少应该先使用一次完整的单词或短语及其缩写，之后才能使用缩写。例如，如果文章中提到了 Create React App，你可能倾向于直接使用 CRA。但实际上，第一次提到它时，应该写成“Create React App (CRA)”，然后在文章的其余部分中都使用 CRA。

例如，在编写教程时，如果讲解了方法的使用，即使教程中对方法的解释很简略，也尽量提供该方法的文档链接。这样，读者可以根据需要深入了解细节，并查看教程中可能遗漏的额外信息。您可以链接到MDN Web Docs或其他网站的文档，具体取决于您使用的编程语言。

务必注明来源。

与上一节类似，您应该尽可能提供原文链接。如果您提及调查或研究结果、浏览器限制、其他文章或书籍的引用，或任何来自原始来源的内容，请务必链接回该来源。这有助于提升文章的可信度，并维护读者的信任。此外，读者也可以自行查阅原文，并在需要时了解详细信息。

创建风格指南

刚开始写文章时，你可能不太在意遵循特定的写作指南。然而，为了保持博客整体风格的一致性，并确保文章结构清晰，制定一份风格指南是很有必要的。风格指南应该包含文章必须遵循的标题类型、特定的用词和格式，以及其他你认为对写作有帮助的规则。你或许会感到迷茫，不知从何入手，但随着写作的深入，你会逐渐理解自己正在创建的博客类型，一切都会变得清晰起来。

首先尝试制定一套内容格式规范。例如，文章中每个新章节或每个标题后都应该换行。从简单的规范开始，随着时间的推移逐步完善。

平均字数

我在为各种平台写作的过程中学到的一个很好的技巧是，文章篇幅最好控制在1500到2000字之间。你不必总是把文章限制在这个范围内，但设定一个平均范围很有帮助，这样可以让你更好地掌控文章，知道什么时候可以缩短或分成几部分，什么时候应该写得更长一些，包含更多细节。

很多时候，我写完一篇长文后，再仔细检查一遍，才发现自己重复了很多不必要的内容。所以，写完文章后，如果篇幅过长，一定要尽量删减不必要的细节和重复的语句。确保文章或教程紧扣主题，而不是堆砌无关的细节。这样才能帮助读者更好地理解文章内容，避免迷失在无关的细节中。如果是教程，而且可以分成几个部分，那就这样做，这样对读者来说会更方便。

另一方面，如果文章太短，请仔细检查。是否存在含糊不清的细节？是否存在容易引起混淆或误解的地方？如果存在，请花时间重申或详细阐述你想表达或传授给读者的内容。很多时候，我们认为自己的观点表达清楚了，或者我们想传授的内容很容易理解，但实际上，文章最终却忽略了重点。

学习和写作

在开始写作之前，我一度停止学习新事物，固守已知，从未进步。开始写作后，我开始拓展知识面，学习新的写作主题，尤其是在为 SitePoint 或 Draft.dev 等平台撰稿之后。很多时候，我被分配到的文章主题，要么是我略知一二的，要么是我几乎一无所知的。然而，因为必须写这篇文章，我便会深入研究，探究主题的细节。这帮助我学习新知识，拓展视野。我写作不仅是为了帮助他人，也是在写作的过程中不断学习。

额外提示：对自己所知充满信心

很多人想写作，但又害怕自己的知识不如别人，或者害怕写出来的东西对别人没有帮助。我刚开始写博客的时候也有同样的感受。我当时觉得我了解的东西大家都知道，写这些话题也帮不了任何人。然而，当我开始写我了解的各种话题之后，我收到了许多信息和邮件，感谢我帮助他们解决了问题，让他们对某个话题有了更深入的了解，或者帮助他们更好地理解了一些事情。即使你觉得自己知识有限，也不代表别人不能从你身上学到东西。我们谁都不是无所不知的，总会有人能从你分享的内容中受益。

此外，即使你的文章无人阅读或从中受益，你也会从中获益。我写的每一篇文章或教程都让我学到了新东西。有时是在尝试或搜索某些内容时学到一些小细节，有时则是对整个主题的理解。归根结底，至少会有一个人从你的文章中有所收获，所以对此要有信心。

结论

如果你正在考虑为这些平台撰稿，不要犹豫，也不要觉得自己做不到。你可以随时申请尝试，希望你也能从写作中有所收获。

我会在下面附上申请为这些网站撰稿的链接。如果您感兴趣，请花些时间浏览一下。

• SitePoint
• 草稿.dev
• LogRocket
• ContentLab.io