技术文章创作心得分享 - 开源动态

本文将分享近段时期以来的技术文章创作心得体会，如果你也正在写作的路上，希望这篇文章能对你有所帮助或启发。

笔者在去年下半年发表了约莫 40 篇文章，几个月内在掘金升级到优秀创作者，达成了里程碑式的小目标，其中一篇文章被官方评选为 2022 年度爆款好文，也算是十分难得的肯定。

为什么写作

技术写作确实没有什么门槛，还会有诸多好处，比如：

加深对知识的理解

写文章需要你对问题展开较为全面的思考，同时这个过程中你也可能会需要查阅资料对观点进行补充，促使你主动持续学习，持之以恒必将大有裨益。

集思广益

文章下开放性的讨论往往可以启发你的想法。

求职亮点

经常写技术文章能在一定程度上证明你的学习力，面试官甚至可以参考你的博客内容对你的水平进行更深层次的评估，这比起口头交谈更有说服力。

提升表达力

能把技术原理讲明白透彻是一种不可多得的能力，文字表达同样也需要长时间的锻炼。

其实说起来，所有的技术文章大体上都可归为两类：记录或分享。

对于大部分人来说，很难一开始就创作体系化的文章，所以我起初都是想到什么就写什么，这个阶段比较多都是写些笔记，谈不上真正的文章。

笔者实践类文章写的比较多，以此类型来说的话，一份笔记的生命周期大致如下：

然而笔记只需要做到自己看得懂就行了，作为具有可读性的文章往往普适度还不够。

当一份笔记进行到上述第三步总结的时候，通常就可以大致形成一篇技术文章的雏形了，接下来就是完善复盘、抽象归纳、内容结构组织、总结等加工。

当你不再只停留于记录笔记，并开始技术文章的写作和分享时，你一定想知道如何写好一篇文章。

起好标题

标题要能高度概括出文章主旨是什么，最好还能引起读者阅读的兴趣。

有人会说我不想当标题党，其时我觉得所谓标题党应该是指那些仅靠夸张标题博人眼球，实际内容贫瘠甚至牛头不对马嘴的文章。如果你花了许多时间精力创作内容，却对标题敷衍了事，又如何让人相信你的内容真的值得一读呢？

结构清晰

一般我会采取「总-分-总」结构，前言是总结的一部分，包含了文章内容的关键信息提取和介绍，通常是引起读者兴趣，更清楚地表明主题立意，或是说明文章所适合的阅读人群。

整篇文章的内容建议不要太长，太长了容易消磨读者的耐心，太短了只适合写成笔记，很难有阅读价值，所以内容的分段比较考验作者的内容组织的经验和能力。笔者建议文章篇幅大于 500 字不超过 8000 字就可以，观点仅供参考。

保持谦虚

谁都可能有犯错的时候，在技术文章中我们可以适当保持谦虚的态度，希望多听取建议或意见，同时也应避免自己主观的认识给别人带去误导。

遍历通读

这不仅是检查错别字，而是把自己代入到读者视角，检查行文是否流畅通顺，笔者没什么天赋，所以每一篇文章在发布前都至少通读了十几遍。

惜字如金

宝剑锋从磨砺出，做减法其实要远比做加法难，要懂得少即是多的道理，文章越精炼越值得一读。

图文并茂

适当配图有利于文章的可读性，同时应该避免大量图片导致排版失衡，图片过大让文章“抖动”影响体验等，例如动图最好剪辑压缩过后再上传。

实践真知

计算机科学的基础还是实践，无论是讲原理还是讲应用的技术文章，都最忌讳空谈。很多人觉得想不出选题，文章不知道写什么，很可能也是缺乏实践的经验，我们毕竟不是为了写作而写作。

技术文章创作基本都是使用 MarkDown 格式，这种格式语法非常简单，即使完全没有接触过的人，也能在一天之内精通。

同时 MD 格式也是支持大部分 HTML 语法的，例如我用语义化 HTML 实现如下部分文字隐藏的功能：

查看答案

<details>
<summary> 查看答案 </summary>
这是折叠起来的文字内容，你看到我了
</details>

这里结合个人一些心得体会具体说下排版的小讲究：

目录嵌套清晰，通常每个段落的一级标题用 ##，接着它的次级标题就是 ### 以此类推。
看到不少文章用代码块来强调重点词语，虽然在一些主题中确实有高亮效果，但按规范可以用 ** 包裹住加粗来表示强调，也避免了不同网站主题观感不同。
文章中不要放大段代码，只展示关键代码即可，这样能降低读者的阅读难度，记得三个 ` 后面要加语言描述（如 js、java等），这样才有正确的词法高亮效果，这点经常容易遗漏。
展示代码除特殊情况下尽量不要用图片。
代码篇幅大时用在线工具（如码上掘金、codepen等）链接出去，或者把完整代码托管到 Github 仓库当中，尽量别让代码喧宾夺主。
英文和数字前后一定要加空格，这样更美观易读。
中文文章写作不要使用半角符（如 , . ; 这些）代替全角符号。