浅谈技术文章的写法

作者阿里云代理 文章分类 分类:新闻快递 阅读次数 已被围观 743

写作前

自测

在写一篇文章之前,先想清楚以下几个问题:

  • 文章类型(教程型,总结型,研讨型)
  • 这篇文章是写给谁看的?有必要写吗?(分析受众)
  • 这篇文章主要讲些什么,不讲些什么(解耦知识)
  • 你真的了解这些知识吗?(知识总结)
  • 这三个问题想理解了,其实一篇文章也就呼之欲出了。

分析受众

在我们产品之前,需求先分析政策用户,写技术文章也相似,清楚了政策读者,你才知道要产出一篇怎样样的文章,一切脱离了读者写出来的文章是不会获得预期的反应的。比如说招聘季,写一些面试题的分析就很吃香。

比如,你的政策是小白用户,他们或许连 Node.js 都没有设备过,你上来就让他们配个 webpack 以达到什么目的,这必定不靠谱,你就得先奉告他们怎样去设备 Node.js。

但假设你的文章面向的是更深层次的讨论和分析,为了这部分小白用户去添加篇幅大可不必,只会让那些真实的中高级开发者觉得这篇文章言之无谓,原本的价值大打折扣。

像《从入门到知晓系列》这类出版的书,也是为了照料新入门的准开发者们从零根底初步的,包括不了知晓所需的许多东西,而像《JavaScript 忍者秘籍》这样的书又不会说明最根底的语法内容,新手就或许一头雾水。实际上,一本书不或许左右逢源,一篇文章就更不或许了。

内容的必要性,不仅仅是指文章部分内容有没有必要,更重要的是整篇文章是不是一个伪需求。假设一个东西的官方文档十分清楚,没有任何骗局可言,或许是市场上现已存在了对应的文章排在搜索引擎的前三名,完美处理了你想要处理的问题,那大可不必写一篇相似内容的文章,因为那并不能发明文章应有的价值。从另一个视点讲,你可以去寻觅一些其他文章没有说到或许说清楚的点,去进一步深化文章的内容,发明新的价值。

解耦知识

我们有时分会遇到这样一种情况,在说明某一个问题的时分,这个问题接连产生了另一个问题,假设读者不知道前置知识,或许后续问题我也觉得值得介绍,该怎样办呢?

在刚刚我们现已讲到了首先要清楚你的政策读者,比如你讲「Webpack」这个主题,在限制政策读者时,就应该限制读者有前端构架东西和工程化自动化这样的概念根底。

在比如说我们写完了一个服务,有许多问题都值得大谈特谈,可以说上三天三夜,但是如同模块的解耦相同,我们可以抽出一个个小的模块来一章一章的独自阐明,关于一些明显与自己的事务有联络的名词或许代码,将它们抽象成更系统的架构中的小模块,而不是逼迫读者去了解你所做的详细事务。

一个服务,写的代码是事务,做的规划是系统,但是表达出来的,应该是架构。

这种知识的解耦在一些系统级别的文章中是十分有必要的,文章同样是可以模块化的。
它能让你的文章更加独立,一起也更容易了解你在这项服务中的中心思路。

知识总结

在写文章之前,我们先要反复向自己提问:自己真的搞清楚这些知识点了吗?假设还没有,不要轻易落笔——这一起也促进自己去真实深化了解这些知识点。或许我们都会遇到相似的问题,看到一篇技术文章,苦思冥想而不得解。有时分是作者自己的思路很紊乱,并且对知识的了解并不深入,换位思考,我们在写技术文章的时分就要理清思路,确保自己对文章内容的正确了解。

为了搞清楚你想说明的问题,你会去搜集一些比本来你处理时看到的多得多的资料,来力图确保自己内容的正确性,可以把这些内容保存下来,作为自己之后的「参阅文献」。

假设你觉得你想理解了,无妨想想,假设你是读者,会不会有这些知识贮藏,能不能理解你在说些什么,这和小黄鸭调试法相似。在确保了自己能梳理清楚整个知识点之后,方可落笔。假设不理解,也可以把一些需求的知识贮藏放在文章的最上方并注明,便利用户进行学习。把自己设定为政策读者,以此来总结全文知识,也是一个十分重要的才能和办法。

写作时

大脑里有了整篇文章想要表达的主旨思路之后,文章其实呼之欲出,在写作时我们还应该留意一些行文细节,供参阅:

行文风格

在编写文章内容的时分,不该该去寻求高大上的表达方式,或许过于浮夸的表现手法,我们的目的不是参加散文比赛,应该力求文字的灵通晓畅,最重要的是可以让你的读者读理解,了解你要表达的意思。

文章的层次结构

假设文章比较长,那么可以考虑在文章最前面或许在阶段前给人以暗示:接下来的内容与前文内容的递进亦或许是并排联络。关于较长的文章(超越 1000 字即可考虑),过分随意的层次结构会显得全文支离破碎,不成系统,很难让人了解作者想要表达的含义,可以恰当运用不同层级的标题来表达出文章的层次结构。

清楚的中英文标点

假设是中文写作,请必须用中文标点,因为那能让你的句与句之间变得更加清楚清楚,请必须运用正确的标点符号来表达你的意思,慎用比如感叹号之类的带有情感倾向的标点。

长短句结合

短句可以加速人们的阅读速度,依据某研讨,短句可以加强人们的阅读喜好,但是过多的短句会让文章变的过于琐碎。过多的长句会让人感到疲乏,恰当的长句和短句的结合就可以很好的控制阅读的节奏。

阶段长度适中

为什么许多人不喜欢论文和教科书,而更喜欢博文呢?因为前者的阶段中信息量太大,往往一眼望去,一页一阶段,一篇一国际。关于一般的技术文章而言,一段最好控制在五六行左右,不会显得文字堆砌,更能引发读者的阅读愿望。

错别字

古人或许把错别字当通假字,但关于技术文章而言,过多的错别字,尤其是差错的技术名词,比如一些技术名词的规范书写:javascript和JavaScript。或许会引起人们的恶感:「不专业」的帽子就会扣过来。此外,一些错别字还会构成阅读时的中止,或许会需求大脑额定中止去处理这些错别字,影响了阅读体会。

慎重的掌握文章基调

技术文章不意味着十分呆板和说教,你可以在自己的博文中显示出自己的诙谐和风趣的语言风格,但仍然应该处于一个可控的规划,让人感受到这是一个有涵养和风趣的人,而不会认为这是一个轻浮、没有真材实料的人。

写作后

自发审阅

关于大多数独立博主来说,自发审阅是最终一道工序,自己过一遍,确保没有犯初级差错和误导性的差错,然后就可以悄悄一点发布了。

版权相关

在发布前,请必须留意你的文章中所有引证部分符合了原作者的规定,若为成段运用,运用之前可以先咨询原作者获得授权。要有版权意识。

无人问津怎样办

「莫愁前路无知己,天下谁人不识君」这句诗在这里也适用。文章的内容是一回事,推行又是另一回事,你的文章发布出去,作业现已成功了一大半,最起码你收成了对知识的深入见地。假设不想吃力推行,发在一些社区和专栏里,你的受众自然会「有一双长于发现的眼睛」。


本公司销售:阿里云新/老客户,只要购买阿里云,即可享受折上折优惠!>

我有话说: