写技术文章十年我总结的六个写作心法

从2015年写第一篇技术博客到现在整整十年踩过无数的坑也被无数人吐槽过写得烂今天把这些年的教训总结成六个心法希望对正在写技术文章的你有点帮助。心法一先列大纲再动笔。很多人打开编辑器就开始写写到一半发现逻辑断了我现在写任何超过一千字的文章一定是先花十分钟列大纲大纲不需要多详细只要三层就够了要讲什么怎么分段每段的核心观点是什么有了大纲写作就从创作变成了填空心理压力小很多。心法二第一段决定读者去留。技术文章最容易犯的错是一开头就堆术语读者打开文章的前三秒就决定了要不要继续看前三句话必须让人产生你懂我的感觉我常用的开头套路是先描述一个读者正在经历的痛点。心法三每段只说一件事。技术文章最忌讳一段话说好几个事读者脑子转不过来就划走了每段一个核心观点用标题标注清楚这样就算读者跳着看也能抓住重点。心法四代码块里必须加注释。光贴代码等于没写读者最需要知道的是这段代码在干什么为什么这么写有没有坑我现在的标准是代码块下面至少要有三行文字解释。心法五结尾要给行动建议。看完文章的人最想知道的是然后呢结尾一定要有可操作的下一步哪怕是去读某本书或者试试某个思路。心法六写完放二十四小时再改。刚写完看啥都顺眼过一天再看能发现一堆问题这十年最大的教训就是急于发布结果发了一堆后来想删的文章。这六个心法不是真理但对我确实有用如果你也有自己的写作习惯欢迎聊聊。