思维导图 介绍 最近看到很多这方面的文章,我就想了想,我认为的好的技术文章是什么样的? 这文章主要是写给自己的,对我以后的技术文章有警醒作用。目标群体 不是让你在文章开
简单、明了 你写的文章,尽量应该简单,明白。——写技术文章,应该把复杂的弄简单,而不是把简单的弄复杂,毕竟不是写书。 很多“牛人”,很会卖弄风骚,把文章写的跟旧社会女人的裹脚布一样,又臭,又长。——有的时候我也经常犯这样的错误,虽然我不是”牛人“。 那么怎样写的简单、明了呢? 1、少说废话,把主题句(关键句)给我们拿出来看就行了,甭写一堆的废话。——很多人本来一句话能解释清楚的事情,用上百行字去让人明白。这很大程度上也说明他自己也在迷糊中。 2、可以加一些解释,最多用四句话。——如果超过四句话,说明你还在糊涂中,你就需要“重构“了,把内容尽量缩短。——毕竟你有时间看,但不要浪费大家的时间。 3、用图像把主题意思提炼出来。如果你的图,能说明你的问题,那你就用图表示,再加一些辅助的文字说明(这是大家不明白的时候才看的) 4、技术名词给个连接。——很多人写文章有个特点,当提到某个技术的时候,先介绍这个技术是什么?这用你说吗?现在的百科,wiki哪一个说的不比你清楚啊,你只需要给个连接就行了。 顺序 你最好把你最主要、最重要的东西往前排。——毕竟不会每个人都看完你的文章。大家都是忙人,还要干别的事呢?哪有心思看完你整片文章。 我记得我想看一些技术类的书籍的时候,刚开始很兴致勃勃的去买了相关书籍,结果我看了前两章,实在没心思再往后看了,这种书我通常用半年或者一年的时间去看完。毕竟用我辛苦挣得钱买的,如果不看完,心里亏得晃。 但是我发现,很多开始提不起兴趣的书,越到后面越让我来了兴致,越到后面越精彩,越到后面我的收获就越大。——为什么学点有用的东西就那么难呢? 简短 你的文章尽量要简短。看长长的文章,跟看长函数一样,让人望而生畏。 如果你的文章很长才能说明问题,那我建议你,可以把文章做成系列,分几个系列给大家看。每次回头想看的时候,更有针对性。——这就跟我们写代码一样,不要让你的类太长,如果太长,那你该重构了——Extract Class。 重构 不要以为你能一下就能把你的文章写好,你也不是完人,就算是再牛的作家,也还要不停的修改他的文章呢?何况你只是一个coder而已? 我们写完文章,要经常性的翻看自己的文章。看文章的过程,是我们再一次学习的过程。 翻看的时候,我们自己经常能发现一些问题。如标点符号、错别字、代码错误、语病、文章样式... 配图 尽量配置一些图片,很多时候图片很能说明问题。——如果能配置动画视频,那就更爽了。 很多时候图能说明的问题,是文字无法比拟的。 准确 不要害怕自己的观点错误,或者技术错误,大胆的写,如果有人给你指正出来,那你就去找资料去核实下,然后再去改正,这中间你也能学到很多东西。 不要怕错误——勇者无敌吗! 总结 我知道,很多人看了我的文章有可能会吐血,会拍砖。那就猛拍吧?拍死我算了。 喜欢编程 【文章原创作者:美国服务器 https://www.68idc.cn处的文章,转载请说明出处】