共计 4054 个字符,预计需要花费 11 分钟才能阅读完成。
一、前言
作为一名程序员,常常在网络上查找各种各样的材料。此时,会检索到很多优良的技术文章。一篇好的技术文章,可能不仅仅会解决咱们的问题,更能在浏览的过程中带给咱们一些美妙的体验。许多时候咱们也神往本人能写出优良的技术文章,然而却往往感觉到无从下手。那如何写好一篇技术文章呢?其实是存在一些办法和技巧的,上面咱们就对这些内容进行具体的介绍。
二、写作目标
在正式介绍如何写技术文章之前,咱们先来看下为什么要写技术文章?因为晓得了咱们的目标,能力有能源更好的实现写作。
2.1 写给本人
可能看到这个题目之后,大家的第一反馈是感到纳闷。因为在大多数人心目中,写技术文章的次要目标不是给别人分享本人的常识么?针对这个纳闷,我的答复是:
对于技术文章的读者而言,可能学到一些常识或者解决本人遇到的问题,的确很有意义。不过,大部分技术文章次要是针对某些特定的知识点进行论述。因而,对于读者的好处次要是查漏补缺,想要通过浏览技术文章造成本人的常识体系就比拟艰难了。
对于技术文章的作者而言,通过写作可能取得更大的好处。其实,与其说是写作,倒不如说是“学习 + 思考 + 总结 + 晋升”这一整体的过程。写作自身就是一个学习的过程,而不仅仅是写出一篇文章。
所以,对于大多数心愿学习和成长的同学而言(例如我本人),写作的次要目标是本身的晋升。
2.2 总结学习成绩
咱们在日常工作中,会遇到许多问题,也会想到各种各样的解决办法。随着解决的问题越来越多,咱们理解的知识点也越来越多。然而,这些知识点咱们该当如何积淀下来造成常识体系,便于后续解决相似的问题呢?写作,恰好能够作为对前一阶段学习成绩的总结,将这些零散的知识点串联成本人的常识网络。对于这一过程,能够应用一幅图来示意,如图 2-1 所示:
图 2-1 知识点串联成常识网络
2.3 明确学习方向
为了阐明如何通过写作明确本人的学习方向,首先列举下在简书上我的文章分类,如图 2-2 所示:
图 2-2 简书上的文章分类对于我而言,通过已写的文章就能够明确大抵的学习方向,起因如下:
能够理解本人常识体系中善于哪些常识。例如,通过图 2-2 所示能够晓得,我已经写过 iOS 多线程系列的技术博客。因而,对于 iOS 多线程的相干常识我该当比拟善于。
理解本人善于哪些常识之后,天然也就晓得了本人常识体系中欠缺哪些常识。因而,对于这部分常识能够重点关注。
便于回顾曾经把握的常识。因为已写的文章都能够归纳到对应的知识点中,如果须要回顾某些知识点,就能够迅速找到相干的文章进行查看。
在理解本人常识体系的前提下,学习的方向性就会强上许多,这也是写文章的好处所在。
2.4 良好的学习形式
“谢谢楼主!您这篇文章给我的播种很大”“浏览量 10000+”“您的文章已被《xx 进阶之路》专题收录”……每当看到这些信息的时候,都会感觉很开心,因为本人取得了他人的认可。此时,对于学习和写作都会产生更大的趣味。一旦趣味有了,学习效率更容易提上去。这里分享一个从知乎上看到的学习金字塔模型,如图 2-3 所示:
图 2-3 学习金字塔模型从图 2-3 能够晓得为什么写作是一种提高效率的学习形式,因为写作正是一种“传授给别人”的被动学习形式的最好体现!
2.5 思考体系化书面表白与口头
表白最大的差别是:口头表白只须要通知对方产生了什么,而书面表白须要把一个事件全面而透彻的讲清楚。如果想要讲清楚一个事件,就须要建设一个清晰的思考体系。写作发明了一个可能降级思考的契机,让你能够把点连成线汇成面。例如,当你须要给刚做过的我的项目写一份总结文档,为了便于读者的了解,你须要思考以下几点:
我做这个我的项目是为了解决什么问题?
业界其余团队在面对这个问题时会采纳什么计划?
我的计划与他们的计划比照起来有什么劣势?
将来有哪些潜在的可迭代优化的方向?
而当你把这些问题都想明确写分明,就造成了一个清晰的思考体系,天然会获得更大的提高。在上述的几节中,咱们应用大量的篇幅论述了写作的目标。起因就是心愿大家可能了解:写作,首先是一条自我成长之路。
三、写作步骤
明确了写作目标之后,接下来就该具体介绍如何写一篇技术文章了。在写文章之前,先想分明以下几个问题:
是写给谁看的?
主题是什么?
提纲怎么写?
如果这几个问题想分明了,文章天然也就瓜熟蒂落了。
3.1 指标用户
首先剖析文章会给谁看,即文章的指标用户。有了指标用户之后,才晓得须要产出一篇什么样的文章。例如,你的指标用户是从未接触过 iOS 的群体,他们可能连 Xcode 都没有装置过。如果上来就讲 iOS App 性能调优,这根本会导致你的指标用户感觉不知所云。然而,如果你的文章面向的是更深层次的探讨和剖析,为了这部分未接触过 iOS 的用户去减少篇幅大可不必,只会让那些中高级程序员感觉这篇文章奇文瑰句,本来的价值大打折扣。实际上,一篇文章不可能八面玲珑。即便是书籍,也会有一个读者群体。因而,首先该当明确文章的指标用户。
3.2 确定主题
文章主题涵盖的范畴不宜过大,写大而全的货色对作者的程度要求十分高且须要耗费大量精力。如果真想写,也该当先把思路理清,与有教训的人交换之后再开始。筛选的主题该当是本人理解透彻的货色。如果对于一些细节不太理解,也务必将这些细节点叙述分明。
3.3 寻找知识点
主题确定好之后,围绕这个主题会有许多相干的知识点,能够通过网络或者其余的形式找到一些论述主题所需的知识点。例如,咱们想写一篇主题为 iOS crash 剖析的文章。围绕这个主题寻找材料,能够找到诸如 crash 的类型、呈现的起因、如何收集、如何防止、呈现 crash 不让程序解体的办法等相干常识。而后,筛选咱们须要介绍的知识点。如果这篇文章次要是解说如何收集 crash,那就能够将 crash 类型、呈现的起因、如何收集这些知识点列入论述主题所需的知识点,而如何防止等相干知识点就不须要列入咱们所介绍的范畴。
3.4 提纲和题目
确定主题和所需知识点之后,将须要介绍的知识点依照逻辑程序或者内容由浅入深进行排列,造成一个提纲。定义提纲是有技巧的,对于技术文章,根本都是有构造可循的,提纲题目尽量做到长篇累牍。例如,在上一步中咱们曾经确定好所介绍的知识点为 crash 类型、呈现的起因、如何收集,联合技术文章的根本构造,提纲依照由浅入深就能够列为:
- 前言(根本构造)2. crash 收集(一共两种 crash,别离介绍类型、呈现的起因、如何捕捉)2-1. NSException(1)NSException 类型常见的异样(2)常见异样呈现的起因(3)如何捕捉 2 -2. Unix 信号(1)Unix 信号类型常见的异样(2)常见异样呈现的起因(3)如何捕捉 3. 踩过的坑(能够依据理论状况确定是否须要)4. 总结(根本构造)5. 参考文献(根本构造)6. 联系方式(能够依据理论状况确定是否须要)依据主题和提纲,设计一个突出核心的题目即可。例如,依据下面例子中的主题和提纲,文章的题目能够设计为《漫谈 iOS crash 收集》、《iOS crash 收集原理》等。3.5 欠缺内容提纲一旦确定,剩下的工作就是将内容填充到各个目录之中。这里须要留神的是,欠缺内容时尽量做到上面几点:
内容正确
图文并茂
语句通顺
格局正当
举例说明
3.6 重复批改
一篇优良的技术文章并不是写进去的,而是改进去的。文章初稿造成之后,能够把本人设想成读者,尽量多读几遍,重复批改之后达到通顺易读即可。
四、写作技巧
4.1 开始
万事开头难,写作也是一样。不管当初是什么样的程度,如果想进步写作能力,最好的形式就是开始写。可能开始写的几篇文章不够好,然而随着数量的减少,肯定会导致量变的产生。
4.2 模拟
写出第一篇优良的文章将会是一个良好的开始。然而,对于那些写作老手来说,这往往也是最艰难的,很多人会感觉无从下手。针对这种状况,我的倡议是从模拟开始。有些读者可能目前还不长于写作,但肯定浏览过那些优良的文章,无妨模拟那些优良的文章,学习他们是如何给文章起题目的、如何写开场白、如何论述他们的观点以及如何总结的。通过模拟,会慢慢造就起写作的感觉,并且越写越好。
4.3 多写
任何事件都不能欲速不达,写作也是。想要写出优良的文章,最好的形式还是重复练习。游刃有余,写的多了天然会更容易写出优良的文章。
4.4 内容技巧
在写具体内容时也有一些技巧,例如:
应用适合的称说。为了让读者感触到浏览这篇文章就像是在和作者对话一样,文章中能够用“我”或“咱们”来示意作者,用“您”或“大家”示意读者。
对长句进行断句。要多用短句,防止长句,目标是让读者浏览起来体验更好。
采纳多种表达方式。正所谓“一图胜千言”,对于文字不好表白的中央能够思考应用插图、表格等模式。
文末总结。文章结尾时肯定要有总结,让读者读完文章后,可能疾速抓到重点,有一种“深入浅出”的体验。
五、总结
本文基于本人对于技术文章写作的一些感悟,同时联合了一些领导写作的优良文章,总结了写作步骤和写作技巧,心愿能给大家在技术文章写作的过程中提供一些帮忙。因为工夫仓促,集体程度无限,如有谬误之处欢送大家批评指正。
最初,援用之前看到的一句话作为本文的完结:“写作自身是一件十分有意义的事件,它将使你变得更加勤于思考,思维也将变得更加成熟与欠缺。同时,你也会为本人用心写出的每一篇文章而感到自豪,并从中取得信念”。
参考文献
【编程之外】为什么咱们要写技术文章?
(https://www.cnblogs.com/pengh…)
知乎上竭力推崇读书的人为什么不把上知乎的工夫都用来读书?
(https://www.zhihu.com/questio…)
写文章对程序员很重要吗?
(https://www.zhihu.com/questio…)
你也能够写出优良的技术文章。
(https://www.jianshu.com/p/954…)
如何写好一篇技术文章?
(https://blog.csdn.net/EAPxUO/…)
技术写作是有技巧的。
(https://blog.csdn.net/qq_3487…)
文章起源:公众号神策技术社区