如何写好一篇技术文章？

本文主要针对想在掘金等技术社区公开发表文章的同窗，面向我的写做的笔记等内容不在本文讨论范围内。同时，我认为面向我的写做的任何东西都不宜在社区公开。

选择合理的内容
技术那么多，到底哪一种适合写哪一种不适合写？

常见的适合成文的内容有：

• 新出现的技术
• 工程中解决问题的方法
• 高深问题的剖析
• 被大多数人忽略的重要细节

文章内容的范围不宜过大，写大而全的东西对做者的水平要求很是高且须要消耗大量精力。若是真想写，也请先把思路理清，与有经验的人交流以后再下笔。

一个小技巧是：在写文章以前，先把本身想写的主题用搜索引擎中搜一下，考虑本身是否有信心有能力超过已有文章。若是没有相关文章，那么能够先写入门级的内容，根据社区反馈逐步深刻。

确保内容的准确性

本身挑选的写做内容可能是本身摸透了的东西，可是在细节上可能有模糊不清的地方。注意，你模糊不清的地方也正是许多人看此文的动机，务必查阅文献将此处叙述清楚！但又不可沉溺于细节之中，以能讲明白上下文为宜（更深刻的细节适合另起一文）。另外，相似选型、对比、趋势一类的文章，对行业总体的把握也很是重要，在表达本身的观点以前，应该充分了解其它人的见解，尤为是和本身观点相左的见解。

写做手法

技术文章的一大特色是文章逻辑严密，层级分明。所以在写做以前，应先列好提纲，根据内容层级由浅入深。

大部分技术知识能够用代码讲清楚，那么此处务必贴出代码。代码应该结构清晰，逻辑简单，能讲清楚问题就行了。一些关键代码须要有清晰的注释。若是有 demo，能够放上 demo 的连接。

文章第一段应该交代清楚文章的受众以及所需的前序知识。最好能用 2~3 句话对文章所要表述的内容进行归纳。

文章的遣词造句也很重要，在深刻叙述细节以前，宜先主动抛出一个问题。好比接下来要讲矩阵相关知识，就能够提问：什么是矩阵呢？而后再对矩阵作出介绍。这样能够引导读者思考，跟上做者的写做思惟。

在对高深内容或者细节进行描述时，即便前文已对相关名词作出了解释，也不该该堆砌专有名词。尽可能用白话或者类比的形式将问题解释清楚，文字叙述不清楚的地方，请做图。

版面

相信大部分技术人都有轻度洁癖，因此版面的整齐和缩进无需多言。提几点会让版面看起来清爽的建议：

• 将“ ”替换为「 」
• 英文与中文之间空一格。好比 juejin.im 这样的形式。
• 段与段之间空一行
• 代码块务必渲染。

标题

UC 式的标题的确能够吸引人，可是技术文章的受众是长期活跃在互联网上的人，对震惊体早已有抵抗力。不如务实一些，让读者能根据标题就对文章要讲什么有大概的了解。短时间看损失了阅读量，但从长远来看，是树立我的品牌的好办法。

总结

总的来讲，一篇优秀的技术文须要有

• 简洁朴实的标题
• 不易重复的内容
• 内容表述准确
• 细节描述清析
• 良好的格式和排版

成文以后，须通读一遍文章。将本身代入读者的思惟，边读边考虑在没有为写做本文而学习的知识的前提下，可否读懂文章。

写文章是个很是消耗脑力、体力和时间的事情，在动笔以前，Think Twice ~

另外，在掘金写文章能够换百元好书。

感谢：@守候你 @zw.will @sunshine小小倩 @zimo @axuebin @天方夜 @染陌 对本文的建议。