撰写技术博客

由 Mux 主办的 DEV 全球展示挑战赛：展示你的项目！

去年十一月，我为了参加Virtual Coffee的博客月度挑战，写了一篇关于我如何构建写作结构的文章，当时我写了 14,584 字。今年十一月，我将发表第十四篇博客，我不禁反思自己是如何构思并最终将想法转化为可发表的技术博客文章的。

想法

每当你解决问题或学到新知识时，都是写博客的好时机。以下情况都适合写博客：

• 向同事解释某事
• 完成工作中的一个大功能
• 深入研究的兔子洞
• 想研究一下某些东西，以便更好地了解它。
• 纯粹为了好玩而建造一些东西
• 想把你刚刚弄明白的事情详细记录下来吗？

有了想法之后，决定你是要制作指南还是参考书。

指导

指南会一步一步地引导读者完成某项工作或任务。如果你想编写一份指南，可以先问自己以下几个问题：

• 我的文章是写给哪个水平的读者看的？
• 读者需要具备哪些知识才能理解这篇文章？

你想在博客开头声明一些前提条件。这样可以避免你逐个解释所使用的概念。例如，如果你正在使用 React 构建某个东西，可以这样说：“本博客假设你熟悉 React。”

接下来，问问自己，什么是起点1？什么是完全空白的画布？从这里开始编写说明。

代码块在视觉上分割了文本，这有助于引导视线。但是，不要指望代码本身就能解释清楚。这就像向同事解释一个问题及其解决方案一样——你需要提供上下文信息。如果你的代码跨越多个文件，这其中就包括文件名。

参考

参考文章解释或讲解某个概念。它并非提供详细的步骤说明，而是侧重于概括核心思想。我通常先列出一个包含标题的提纲。

当我开始描述一个概念时，通常会意识到还有很多东西需要解释。这意味着我需要在提纲中添加标题，甚至需要把它拆分成一篇全新的博客文章。

与指南相反，参考博客很容易变得冗长繁杂，因此将文本分段非常重要。我使用标题和表情包。

编辑

放一两天后再回来，大声朗读一遍。你会惊讶地发现很多拼写错误。如果能找别人帮你读一遍并给出反馈，那就更好了。

重读时，我经常发现自己反复使用某个词，不得不改写句子。“经常”就是最近一个例子。

我会完善解释，更清晰地阐明各个概念之间的联系。有了指导，我也会亲自按照步骤操作。

结论

任何时候你想更深入地理解某个概念，不妨把它解释给别人听。技术博客是帮助自己和他人共同学习的好方法。