技术博客文章写作的起点
多年来,作为一名前端开发人员,我积累了很多有用的信息,希望能与他人分享。可惜的是,我并不擅长教学。我总觉得需要同时掌握所有知识并能把所有知识都教给别人,这当然是不可能的。而且,我也很难筛选出最重要的概念,因为在我看来,所有概念都同等重要。
当我决定尝试写一篇技术博客文章时,我四处搜索,看看有没有什么指南或最佳实践可以遵循。这时我发现了howtoegghead.com,这是一个面向 egghead.io 讲师的课程创建指南。我觉得它非常有用,如果你正在寻找指导,我强烈推荐你阅读一下。
以下是我认为最有用的几点总结(已针对博客文章进行调整),以及我的一些个人想法。坦白说:这些对我来说都是全新的领域,而且大多只是写给自己的笔记,以此鼓励自己多写作。
决定写什么
一些选题思路:
- 你热衷的事情
- 你最近学到的东西,或者正在学习的东西
- 你最近发现的问题(例如,一个令人困惑的漏洞或意想不到的极端情况)
- 在你看来这似乎很简单,但对经验不足的人来说却可能大有帮助。
务必将主题缩小到非常具体的范围。最好是那种你可以在几分钟内就讲完的话题。例如,我的思考过程可能是这样的:
- 我热衷于无障碍设计,所以我应该写写这方面的内容! ——这个话题太宽泛了。我甚至不知道从何入手。
- 能够使用键盘浏览网站很重要。——情况有所改善,但内容仍然太多,无法一一涵盖。
- 使用键盘导航时,我首先注意到的是焦点状态必须清晰可见且易于识别——这真是太好了。我终于开始理解这一点了。
- 我将专门讲解按钮的焦点状态。太好了!这听起来似乎很简单,但实际上有很多东西可以讲。
我喜欢这种方式的原因是,我可以写一系列短小精悍、彼此相关的文章,每篇文章详细探讨一个具体主题。这让我可以省略一些我觉得应该提及但与当前主题无关的细节。
如果你想写一些别人已经写过的东西,完全没问题。用自己的语言写作,可以给读者提供另一种视角,或许能让他们豁然开朗。这也是巩固你所学知识的好方法,方便你日后查阅。
我最喜欢的一些博客文章是那些介绍HTML和CSS基础知识的文章。这些内容虽然已经被讲解过很多遍了,但我总能从中学到新东西。
即使你是初学者也没关系。如果你是初学者,你理解的方式可能对其他初学者来说更容易理解。而更有经验的人可能会提供一段代码片段,却没有明确说明这段代码应该放在哪个文件里。或者他们可能会提供一些需要在命令行运行的命令,却没有解释你需要先进入正确的工作目录。这些都是我在学习新东西时经常遇到的问题,而且当你还不了解其工作原理时,这些问题通常很难解决。
表达清晰简洁。
假设你的读者已经具备必要的背景知识。如果他们有任何不了解的地方,可以自行查找资料。
不要添加开头、结尾或背景介绍。想想看,当你搜索食谱时,是不是必须先阅读某人的生平故事才能找到食材清单?我们希望保持简洁,所以只包含人们真正需要的内容。
请展示你的过程
提供一系列可编辑的代码示例。阅读文字描述是一回事,亲眼看到实际应用又是另一回事。与其用文字空泛地描述,不如用代码示例来证明你的观点。以下就是一个例子:
通过提供一系列示例,读者可以看到流程的每个步骤及其对结果的影响。而且由于这些示例可以编辑,读者可以选择修改代码,从而更好地理解其工作原理。
现在你可以开始写作了!
我整理这份清单是因为之前没有写作指南可循,很难着手写作。现在有了起点,我希望它能帮助我以后更轻松地完成写作。
您在构思写作主题或文章结构时会使用哪些资源?或者您是否有自己喜欢并行之有效的写作流程?我很想了解其他人是如何做的!
写完这篇文章的大部分内容后,我才发现阿里·斯皮特尔的博客文章工作流程,里面有更深入的讲解——如果我早点发现就好了!😉
文章来源:https://dev.to/elizabethschafer/a-starting-point-for-writing-technical-blog-posts-n2o