停止水文！！给你一篇全能的技术文章大纲
写在开头
搜索技术文章是开发中解决问题非常重要的一种方式，我相信大多技术人员都曾多少写过文章，现在的网络上也充斥着大量的“水文”，那我们要如何写一篇有质量的技术文章呢？
偶尔我也会写一些技术文章，作为技术开发比较注重逻辑严谨，所以做事前后，总结方法论很重要，在我的笔记里列过一篇写作大纲，在我写技术文章时，会参考该大纲，偶尔有新的想法也会补充进去，让我的行文更加严谨，也大大缩短我写作的时间。本文我会分享下我常用的写作大纲。
何为水文
在我看来要写一篇技术文章供他人阅读，行文严谨，逻辑紧凑，循序渐进，便于阅读，远远比内容是否特别深刻更重要，文章是表达者和倾听者间的桥梁，让读者以最短的时间有最大的收获并且有良好的阅读体验是一遍文章的终极意义，你要先达到 “及格线” 才有可能 “更深刻”。
总之，无论你写什么内容，最终结果如果是没人读或读了很难读懂，那这篇文章就可以称作是一篇浪费读者时间的 “水文”。
其次，技术文章最重要的就是【严谨】和【客观】，不是炫耀或发泄的地方，如果你的调研不够严谨甚至有失偏颇，那这将是一篇更加糟糕的“水文”。
对于水文，最大的贡献就是不要发布到互联网上！！
内容要求
目标受众
- 写作前要先确定受众群体，定位该文章的写作方式，难易程度。
文章骨架
- 先搭建文章骨架，列写作大纲，内容紧凑严谨有序，忌随心所欲，内容散乱，主题不明（不列大纲就容易写跑题）。
内容分类
- 确定文章类别，如普及前沿技术不要太多技术细节，讲解前世今生落地未来思考等广而全；写技术细节需要深入理解；写实践需要经验之谈。
行文风格
- 严肃or活泼，同一文章保持风格一致性。
- 技术文章最初应该是严肃文学，但现在有很多作者不拘一格，行文诙谐幽默，表情包配图，也算是给读者枯燥的工作学习带来一丝乐趣，我印象最深的就是 张鑫旭 的博客的抽象文学，在最开始学技术过程中带来很多乐趣。
- 但是我要提：切勿过度抖机灵，毕竟技术本身还是严谨的，并且不是每个人都是情商大师，幽默家，我看过很多文章穿插各种抖机灵，确实让人观感变差，很尬。
干湿配比
- 所谓干湿配比就是一篇文章干货当然最核心，但是文章的起承转合，铺垫过渡总结，良好顺畅的阅读体验也很影响读者最终在文章中的收获。
参考文献
- 注明文中借鉴引用的主要出处，方便追本溯源，也便于读者扩展阅读，也使行文更加严谨可信。
排版措辞
- 技术文章不用太花哨，但也不要动不动就一大段文字好几行，起码是简洁清晰结构化的。
写作大纲
假如我们要针对某一新技术写一篇技术文章，那我们可以使用以下大纲：
1. 小编前言
- 前言，小编前言，概述，写在开头，我一般喜欢以这几个段落之一作为文章开头
- 先一两句话简单概述文章内容，表达写作目的，帮助读者快速甄别这是不是他想看的文章
- 让读者有准备的去读，带着期待与目的去读，明确他读完将会收获什么
2. 大纲
- 文章段落大纲，便于读者理解文章整体内容，阅读相应段落
- 当我们写较长的科普文或者讲一个很宽泛，有讨论分歧的话题时，由于涉及的基础知识可能会很多，从背景历史、发展进程、技术实现到未来探索，篇幅也会很长，大纲就必不可少，可帮助读者快速了解文章结构，定位到想阅读的文章区域
- 简单说如果篇幅小无所谓，如果篇幅很长，有明确的大纲，会大大帮助读者节省时间
3. 背景
- 文章内容背景，相关基础知识/发展史的简单讲解，正文前的过渡，便于读者平顺的衔接到文章内容，尽量抹平不同读者的认知差异，减少理解成本
- 无论是新概念还是广为人知的技术，先简单介绍下背景，都是很好的铺垫，可以使读者们快速拉齐，清晰的说明写本篇文章的原因，解决哪些痛点
- 读者阅读完背景后，应该对该技术的 “常识” 有了基本的【了解】
4. 用法
- 简单介绍基本使用方式（官方文档）
- 很多时候技术文章核心都是在围绕某个具体技术，我们可以先介绍下基本的使用方式，对标官网即可，官网肯定是一个大而全面的东西，你可以简单概括，使读者以最短的时间达到可继续阅读此文的标准，暂时不需要去官网仔细了解，节约读者时间和成本
- 读者阅读完用法后，应该对该技术的 “使用” 达到了基本的【入门】
5. 优劣
- 在简单了解基本用法后，最快的时间让读者更深入了解该技术的方式就是：介绍下优势与劣势
- 比如一门新技术的出现，优势肯定是解决了现有状态的某些痛点，劣势可能是社区接受度不高，实践少
- 读者阅读完优劣后，应该对该技术有了基本的【理解】
6. 横向对比
- 既然有痛点，那解决方案不太可能只有某一家团队或某一个人在思考，市场上一定还存在同类，甚至已经有比较流行的解决方案了
- 如果有，横向对比必不可少，对比市场上同类技术，介绍与同类技术的差异，优劣，各自的适用场景
- 读者阅读完对比后，应该对该技术在设计使用层面变的更加的【熟悉】
7. 原理
- 在了解技术使用层的知识后，可以通过讲解技术的基本实现原理，设计思想让读者更深入的理解该技术
- 需要着重讲的是，代码其实会给文章本身的阅读提高很大的难度，作者可以用精炼的语言直接表述技术实现原理，这通常比长篇大论的代码更容易理解
- 读者阅读完原理后，不止在使用层面，在底层原理也应该有了一定的【掌握】
8. 源码
- 既然是技术，那实现起来必然绕不开源码，如果你完全理解了该技术的源码，那你就可以说你是彻彻底底掌握了该技术
- 但是源码本身在阅读理解方面有极高的门槛，如果你在文章中加入了源码讲解的环节，会极大的提高文章阅读的难度，事实上大多数读者是不会认真读该环节，因为太过耗时
- 即使有源码讲解，也要配合文章主题，讲解关键逻辑，将源码精简到最简，而不要罗列源码逻辑，可尝试仿照写个简易版的demo会更好理解
- 我个人极不建议在技术文章中夹杂源码讲解的环节，源码适合放在一篇专门讲解源码的文章中，而不是夹杂在某一篇技术文章中，这会严重破坏阅读体验
- 总之，源码比较特殊，如果要通过文章讲解源码，那切记精简精简再精简，让读者读得下去是首要任务，要不然你写的再深刻没人愿意看也没用
- 读者阅读完原理后，对底层原理的理解会更加的【深刻】
9. 现状/落地
- 如果你写的是一门新技术，那介绍下落地是非常重要的，技术再厉害，无法落地那也是空中楼阁
- 如果你是作为一门新技术少数使用过的人，那你在落地过程中的经验分享、最佳实践和遇到的坑对于广大读者来说有非常重要的价值
10. 探索/未来
- 如果是一门新技术，那么对于该技术的思考也很重要，考虑市场接受程度，分析技术定位和未来的趋势，应该以什么态度去持续关注
11. 文末总结
- 几句话总结全文主要表达内容，总结部分一定要精炼，有结构，直接输出内容
- 一个好的技术文章，文末总结绝对必不可少，既总结重点，又可以与读者读后的理解相互印证，帮助读者进一步提高阅读收获
12. 参考文献
- 参考文献、文章、书籍、演讲、官网的友链
- 列出参考文献可以让读者扩展阅读，让你的文章看上去更加严谨
13. 原创声明
- 注明禁止转载或者标注转载需注明的原文地址
写在结尾
在这个大纲中文前通过前言、大纲、背景带读者快速代入，文中通过层层递进，让读者从了解、入门、熟悉到掌握，文末通过落地实践和未来探索使读者理解更加全面而深刻，最后总结与读者思考互相印证，完成这篇文章。
希望这篇写作大纲能在你写技术文章时带来一些帮助，其实像如何写技术文章这种问题在网上搜一下会有很多方法，所有的方法都只是技巧，更重要的是你要理解文章的价值：是要让读者付出最低成本最短时间，并尽可能多而深刻的理解你所要表达的。
无论是演讲、分享、发文这其实都是沟通的一部分，不仅仅是读者受益，对你自己的沟通总结能力也是很大的提升。
如果你很少或者从未写过技术文章，仿照上面的大纲，快速写一篇技术博客吧！！