如何写好你的技术文章？
时间：2012-04-14
作者：川山甲
出处：cnblogs.com/baochuan
最近看到很多这方面的文章，我就想了想，我认为的好的技术文章是什么样的？这文章主要是写给自己的，对我以后的技术文章有警醒作用。
目标群体
不是让你在文章开头写下，你的文章适合什么样的人读？——这是什么意思，鄙视我看不懂你的文章。
我所说的“目标群体”是大家，也包括你自己。你的文章是给大家读的，也是给自己读的。
大家能看你的文章，应该是我们的荣幸，我们应该高兴。现在的互联网是个信息大爆炸的时代，什么文章没有，能看你的文章，有人关注你，难道你不应该庆幸吗？
如果大家能在看你文章的时候，给你写评论，那你更应该高兴，因为人家确实看了你的文章。而且如果给你写一些建议，那你更应该高兴不已。因为你得到了意外收获。
简单、明了
你写的文章，尽量应该简单，明白。——写技术文章，应该把复杂的弄简单，而不是把简单的弄复杂，毕竟不是写书。
很多“牛人”，很会卖弄风骚，把文章写的跟旧社会女人的裹脚布一样，又臭，又长。——有的时候我也经常犯这样的错误，虽然我不是”牛人“。
那么怎样写的简单、明了呢？
1、少说废话，把主题句（关键句）给我们拿出来看就行了，甭写一堆的废话。——很多人本来一句话能解释清楚的事情，用上百行字去让人明白。这很大程度上也说明他自己也在迷糊中。
2、可以加一些解释，最多用四句话。——如果超过四句话，说明你还在糊涂中，你就需要“重构“了，把内容尽量缩短。——毕竟你有时间看，但不要浪费大家的时间。
3、用图像把主题意思提炼出来。如果你的图，能说明你的问题，那你就用图表示，再加一些辅助的文字说明（这是大家不明白的时候才看的）
4、技术名词给个连接。——很多人写文章有个特点，当提到某个技术的时候，先介绍这个技术是什么？这用你说吗？现在的百科，wiki哪一个说的不比你清楚啊，你只需要给个连接就行了。
顺序
你最好把你最主要、最重要的东西往前排。——毕竟不会每个人都看完你的文章。大家都是忙人，还要干别的事呢？哪有心思看完你整片文章。
我记得我想看一些技术类的书籍的时候，刚开始很兴致勃勃的去买了相关书籍，结果我看了前两章，实在没心思再往后看了，这种书我通常用半年或者一年的时间去看完。毕竟用我辛苦挣得钱买的，如果不看完，心里亏得晃。
但是我发现，很多开始提不起兴趣的书，越到后面越让我来了兴致，越到后面越精彩，越到后面我的收获就越大。——为什么学点有用的东西就那么难呢？
简短
你的文章尽量要简短。看长长的文章，跟看长函数一样，让人望而生畏。
如果你的文章很长才能说明问题，那我建议你，可以把文章做成系列，分几个系列给大家看。每次回头想看的时候，更有针对性。——这就跟我们写代码一样，不要让你的类太长，如果太长，那你该重构了——Extract Class。
重构
不要以为你能一下就能把你的文章写好，你也不是完人，就算是再牛的作家，也还要不停的修改他的文章呢？何况你只是一个coder而已？
我们写完文章，要经常性的翻看自己的文章。看文章的过程，是我们再一次学习的过程。
翻看的时候，我们自己经常能发现一些问题。如标点符号、错别字、代码错误、语病、文章样式...
配图
尽量配置一些图片，很多时候图片很能说明问题。——如果能配置动画视频，那就更爽了。
很多时候图能说明的问题，是文字无法比拟的。
准确
不要害怕自己的观点错误，或者技术错误，大胆的写，如果有人给你指正出来，那你就去找资料去核实下，然后再去改正，这中间你也能学到很多东西。
不要怕错误——勇者无敌吗！
我知道，很多人看了我的文章有可能会吐血，会拍砖。那就猛拍吧？拍死我算了。
网友留言/评论
我要留言/评论
相关文章
OAUTH中的腿，2-legged 与 3-legged 的差別:OAUTH协议为用户资源的授权提供了一个安全的、开放而又简易的标准。与以往的授权方式不同之处是OAUTH的授权不会使第三方触及到用户的帐号信息（如用户名与密码），即第三方无需使用用户的用户名与密码就可以申请获得该用户资源的授权，因此OAUTH是安全的。
6本值得一读的JavaScript英文电子书:Web开发行业是一个快节奏的行业。新趋势、技术和API不时出现，我们必须去学习。作为一名Web开发人员，我常认为这是我们责任的一部分，或者说我们需要把这个作为一种习惯，以坚持学习或给自我 升级，不能满足现状。我们是为了探索和发现更多的解决方案。
怎样打造高性能的移动用户体验:在新家一点点安顿了下来，不过心里还是缺乏踏实的方向感；猫猫们也都有些瞻前顾后草木皆兵的样子，有待继续习惯；希望大家都好好的。话说眼前的这篇候选文章貌似已然有同行做过译文，不过正像 “关于BeForWeb”中所说的，我只挑那些我喜欢的 、对我自己有学习和收藏价值的内容来做译文，其他方面的因素和我没有半毛钱的关系。不多说，直接进入正题。
程序员需要谨记的九大安全编码规则:历史已经证明，软件设计的缺陷一直是导致其漏洞被利用的最主要的罪魁祸首。安全专家发现，多数漏洞源自常见软件中相对有限的一些漏洞。软件开发者和设计者应当严格检查程序中的各种错误，尽量在软件部署之前就减少或清除其中的漏洞。
25 个非常棒的 CSS3 菜单教程:本文收集了 25 个超棒的 CSS3 菜单教程，同时提供在线演示以及打包下载。
百度统计流量研究院设计小结 - 可视化的快乐:百度统计流量研究院为了将数据更好的传达给用户，我们采用了动态数据可视化的方式（Interactive Infographic）。希望我们的设计能将用户带入到新鲜、愉悦的氛围之中。当然，我们在设计的过程中也体会到了可视化的快乐，并且希望与大家一同分享。
jQuery 工具类库集锦:jQuery 是一个非常棒的类库，但是为了保证代码的干净以及代码的精简，它只提供最核心的功能。所以就有了很多其他的工具来丰富jQuery的功能。我在使用这些工具的时候发现我常常重复的编写一些代码，所以我就开始把它们整理到一个类库中。我把这些代码都包装成了jQuery的代码，但这并不是必须的，你也可以在其他JS类库中使用他们，或者单独使用。
手机应用开发者需注意的20个事项:你想要成为手机开发者吗？你的目标可能是从应用商店中赚取大量金钱，也可能只是为了寻找新的挑战。无论你的目的是什么，当你设计应用时，可能需要考虑到代码层面之外的某些东西。
产品经理应该如何写周报？:奋斗在互联网的每位同学，基本上都要写周报，更甚者还要写日报，但多少人打心底里觉得写的周报没有意义?只是为了写而写?今天，不妨从两个方面，简单说说，如何让周报真正的有意义和有效果。