介绍
最近看到很多这方面的文章,我就想了想,我认为的好的技术文章是什么样的?
这文章主要是写给自己的,对我以后的技术文章有警醒作用。
思维导图
目标群体
不是让你在文章开头写下,你的文章适合什么样的人读?——这是什么意思,鄙视我看不懂你的文章。
我所说的“目标群体”是大家,也包括你自己。你的文章是给大家读的,也是给自己读的。
大家能看你的文章,应该是我们的荣幸,我们应该高兴。现在的互联网是个信息大爆炸的时代,什么文章没有,能看你的文章,有人关注你,难道你不应该庆幸吗?
如果大家能在看你文章的时候,给你写评论,那你更应该高兴,因为人家确实看了你的文章。而且如果给你写一些建议,那你更应该高兴不已。因为你得到了意外收获。
简单、明了
你写的文章,尽量应该简单,明白。——写技术文章,应该把复杂的弄简单,而不是把简单的弄复杂,毕竟不是写书。
很多“牛人”,很会卖弄风骚,把文章写的跟旧社会女人的裹脚布一样,又臭,又长。——有的时候我也经常犯这样的错误,虽然我不是”牛人“。
那么怎样写的简单、明了呢?
1、少说废话,把主题句(关键句)给我们拿出来看就行了,甭写一堆的废话。——很多人本来一句话能解释清楚的事情,用上百行字去让人明白。这很大程度上也说明他自己也在迷糊中。
2、可以加一些解释,最多用四句话。——如果超过四句话,说明你还在糊涂中,你就需要“重构“了,把内容尽量缩短。——毕竟你有时间看,但不要浪费大家的时间。
3、用图像把主题意思提炼出来。如果你的图,能说明你的问题,那你就用图表示,再加一些辅助的文字说明(这是大家不明白的时候才看的)
4、技术名词给个连接。——很多人写文章有个特点,当提到某个技术的时候,先介绍这个技术是什么?这用你说吗?现在的百科,wiki哪一个说的不比你清楚啊,你只需要给个连接就行了。
顺序
你最好把你最主要、最重要的东西往前排。——毕竟不会每个人都看完你的文章。大家都是忙人,还要干别的事呢?哪有心思看完你整片文章。
我记得我想看一些技术类的书籍的时候,刚开始很兴致勃勃的去买了相关书籍,结果我看了前两章,实在没心思再往后看了,这种书我通常用半年或者一年的时间去看完。毕竟用我辛苦挣得钱买的,如果不看完,心里亏得晃。
但是我发现,很多开始提不起兴趣的书,越到后面越让我来了兴致,越到后面越精彩,越到后面我的收获就越大。——为什么学点有用的东西就那么难呢?
简短
你的文章尽量要简短。看长长的文章,跟看长函数一样,让人望而生畏。
如果你的文章很长才能说明问题,那我建议你,可以把文章做成系列,分几个系列给大家看。每次回头想看的时候,更有针对性。——这就跟我们写代码一样,不要让你的类太长,如果太长,那你该重构了——Extract Class。
重构
不要以为你能一下就能把你的文章写好,你也不是完人,就算是再牛的作家,也还要不停的修改他的文章呢?何况你只是一个coder而已?
我们写完文章,要经常性的翻看自己的文章。看文章的过程,是我们再一次学习的过程。
翻看的时候,我们自己经常能发现一些问题。如标点符号、错别字、代码错误、语病、文章样式…
配图
尽量配置一些图片,很多时候图片很能说明问题。——如果能配置动画视频,那就更爽了。
很多时候图能说明的问题,是文字无法比拟的。
准确
不要害怕自己的观点错误,或者技术错误,大胆的写,如果有人给你指正出来,那你就去找资料去核实下,然后再去改正,这中间你也能学到很多东西。
不要怕错误——勇者无敌吗!
总结
我知道,很多人看了我的文章有可能会吐血,会拍砖。那就猛拍吧?拍死我算了。
分享到:
相关推荐
健壮、优雅、灵活和易维护的软件架构是怎样炼成的?本书通过一系列优秀的文章回答了这个问题,这些文章来自于十几位当今一流的架构师。在每篇文章中,作者都向我们展示了一个著名的软件架构,并分析了什么让其具有...
文章为大家介绍了成为硬件工程师应该要注意的一些事情。
它的学习能力之强,就好像炼丹一样,把一堆杂乱的信息炼成了能和人类沟通的“仙丹”。 那GPT是怎么学会聊天的呢?GPT的这个“大脑”需要一个过程叫做“预训练”。就像我们小时候背诵唐诗宋词一样,GPT也要背诵大量的...
外推软件文章秒收录蜘蛛池是什么?#网络爬虫 到底是什么?
IT技术是最常见的职场岗位之一,IT狂人们也在思考:是选择投身值得托付的好公司,和一群最优秀的工程师共同工作,还是在积累经验后自主创业,又或者干脆转型做管理?我们在采访了一圈资深职场人后告诉你:踏实做事,...
绍了功率分析仪的定义、功能、组成和高精度功率分析仪的制作方法和精度要求。
也有很多谜团还有待解开,比如 Model 3 标准版电池组的设计和布局等等,这篇文章是对现有信息的汇总,Enjoy。 特斯拉 Model 3 的电池组到底是多大? 特斯拉原先的车型命名规则是非常直观的,我们以 Model S P100D ...
可以参考本文章.zip时序预测不同注意力机制更好的是哪个?可以参考本文章.zip时序预测不同注意力机制更好的是哪个?可以参考本文章.zip时序预测不同注意力机制更好的是哪个?可以参考本文章.zip时序预测不同注意力...
这篇文章讲明白了.docx机器学习决策树的分裂到底是什么?这篇文章讲明白了.docx机器学习决策树的分裂到底是什么?这篇文章讲明白了.docx机器学习决策树的分裂到底是什么?这篇文章讲明白了.docx机器学习决策树的分裂...
文章带大家来了解一下什么是硬件设计。
心态,所以公众号断更了 1 个多星期,也没有去整理 2022 年的技术文章。 休息的差不多了,抽空也整理下 2022 年潇湘信安公众号发布的所有原创技术文章,为什么 整理 PDF 文档而不是直接发公众号的文章链接呢?因为...
免费文章翻译软件有哪些?有翻译ppt文档的软件吗.pdf
条条大路通罗马,电子/电气工程师的成长历程也因人而异。这条道路上会有荆棘,也会有鲜花,需要耐得住寂寞,也要经得起繁华,百炼成钢,电子/电气工程师就是一步步被「炼」出来的。
微信公众平台公众号文章怎么添加音乐插件?.docx
文?的?例配套源?,?...文章?查看本站原?文章中“基於WebForm的操作Word文??例”一文!如遇??出?,???是否安?了OfficeXP,如果?是出?,?按“基於WebForm的操作Word文??例”一文提示重新做一次即可!!
在pcb线路板制作过程中,焊接技术的好坏也从一定程度上影响到线路板是否能制作成功。因此焊接工作是一项技术活,除了要求焊点必须牢固,保证元件能固定在电路板上外,还要求焊点圆滑,不影响美观。下面本文为大家...
百家号批量发布文章软件怎么卖?
“为什么有些大公司技术弱爆了?” 我的一些不同看法 - 文章 - 伯乐在线1
教你如何复制百度文库中的文章?.docx
5月30日下午,笔者跟随由电子元件采购员、工程师以及技术员组成的工艺观摩团前往华强PCB工厂,莅临现场一探究竟,了解PCB板背后的故事。