草依山的Javascript世界

一个Javascript程序猿的学习纪录剩地,不仅仅是JS,还有Linux、Mac、nodeJs、吃、玩!

如何写好一篇技术文章

概述

最近总是想写很多东西,真正敲下第一个字的时候又觉得没什么可写的,不知道怎么写,鉴于这种情形发生较多,同时我又坚信万事总是有窍门的,决定总结和思考一下其中的套路。

万事开头难

有些人在写之前会想很多问题,比如应该搭建一个blog还是在一个已经有的blog上写?文章的字体应该用哪种,字号应该选多大?这些问题我也曾经深深的陷入过思考。 曾经为了写blog,我自己写了个blog程序,当我发现写作的工具不够好的时候,又写了Mahua。 因为走过弯路,所以我知道什么才是重点,内容内容!有内容的前提下,保证内容的可阅读性,就够了!

你可以选择一个博客平台,可以使用已经流行过了的轻博客(点点Lofter),甚至QQ空间,人人网的日志,百度空间等等这些都可以。

一颗坚持的心

虽然标题是《如何定好一篇》,但是写东西和其它任何可以掌握的技能都是一样的,需要练习。 写文章,更准确来说写技术文章的好处远远大于它有可能浪费你的那一丁点时间,它可以强迫你总结,巩固自己的知识, 学会观察和思考,学会自律,同时由于放到网上,在被搜索引擎索引后,更能帮助很多和你遇到同样问题的陌生人。 最最重要的是,作为一个IT从业者,你的简历上有一个写了大量技术文章的Blog链接,会加分很多!也会给你带来更多的机会

学人之长

任何学习都是从模仿开始,明确了模仿对象的特征,进步之路就会加速,我们来看看好的文章有哪些共同点。

非常合适的标题

标题往往是读者最先看到的东西,简明扼要的通过标题把文章内容传达出来,让读者第一时间知道,这个东西对自己有没有用, 会不会感兴趣。技术文章标题的套路非常简单。

  • 解决问题类的 :XXX的解决办法、XXX的排查过程
  • 怎么做 : 如何XXX、怎么XXX
  • 介绍东西类: 什么是XXX、XXX简明介绍

比如我要介绍npm,就可以以这样的标题: 《npm:nodejs模块管理程序》

不要试图搞一些太花哨的标题,简单、快速传达出文章内容最重要,如果取了一个很花哨的标题,读者被诱导点进来了,内容干货多还好, 过于平实就容易消耗读者对你的信任。

思路清晰、结构清晰、重点清晰

对于主体的内容,还是分三类来说明

  • 解决问题:问题是怎么发现的,排查问题详细过程,总结反思,是否可以更快发现问题,如何再次避免问题。
  • 怎么做的文章: 为什么要这么做?怎么做?做的过程会遇到哪些问题?分步说明,写详细。总结。
  • 介绍类: 什么是?为什么是它?它的优点?它的缺点?它的原理?同类对比,总结。

主体内容之前可以有一小段的概要,简明补充一下标题概括的内容。 文章内容需要注意:

  • 重点内容重复
  • 尽量把有用信息提前,因为有人可能没有耐心读完全文
  • 简单的、普度的方案放在复杂的、少见的方案之前
  • 操作类的,写明命令或者怎么操作,什么环境操作,明确指出预期结果
  • 合理找点小图片,一图胜千言

图

经常翻看,标点符号、错别字、代码错误、语病、文章样式这些都要注意, 但也不要害怕观点错误或者技术错误,大胆的写,能写清楚,如果有人帮你指正,查资料核实,再改正,会提高很快, 你看我写《如何写好技术文章》,这里面也有很多问题,但我还是厚着脸皮写下去了,:)。

学而时习之

古人云:『少成若天性,习惯如自然』, 古人还云:『学而时习之,不亦说乎』, 不懈的努力,养成多读、多写和多改的好习惯,配合上套路,写文章的能力一定会快速的提高的。

文章地址: 如何写好一篇技术文章
欢迎关注我的微博与我交流:@草依山
Github上也有一些东西:[Github]
所有文章坚决抵制jb51.net的转载!
标签: 写作 1
2013-10-13

相关文章

2017-03-22 一次算PI的小尝试
2017-02-13 new做了些什么
2016-09-29 [翻译]bash的各种文件载入执行顺序
2016-05-31 phantomjs在linux下截图中文字体问题
2016-04-24 Promise的错误处理

文章修改纪录

加载中...
Copyright © 2013. Create By 草依山, Fork