|
|
51CTO旗下网站
|
|
移动端

技术写作,如何快速做到80分(值得收藏)!!!

如何能让技术人的写作能力快速提升,甚至让人眼前一亮呢?下面分享一些技术文章写作经验,按照下边五个步骤,就可以快速写出80分的文章啦。

作者:阿郎来源:51CTO技术栈|2019-04-09 18:03

【大咖·来了 第7期】10月24日晚8点观看《智能导购对话机器人实践》

我身边不少技术人都有过写书的冲动,后来演变成写公众号,写博客,写专栏,再后来就没有后来了。

看上去容易,写起来难,就是技术人对写作的感受。但是即使不想写也得写,设计方案、项目总结、发布文档、技术说明书之类的总是要写的吧。

如何能让技术人的写作能力快速提升,甚至让人眼前一亮呢?下面分享一些技术文章写作经验,按照下边五个步骤,就可以快速写出80分的文章啦。

Step1:端正心态

很多IT人常以理科生自居,认为自己没有写作天赋,其实写作和编程一样,都是可以学习的科学。

另外还要克服技术人鄙视写作技能的脆弱内心,正视写作的价值。

Step2:明确读者

首先分析文章会给谁看,有了目标用户,你才知道需要产出一篇怎么样的文章。

比如,你的目标是小白用户,他们可能连 Node.js 都没有安装过,你上来就让他们配个 webpack 以达到什么目的,这多半是没什么指望了,你就得先告诉他们如何去安装 Node.js。

但如果你的文章面向的是更深层次的探讨和分析,为了这部分小白用户去增加篇幅大可不必,只会让那些中高级程序员觉得这篇文章废话连篇,原本的价值大打折扣。

实际上,一篇文章不可能面面俱到,所谓《从入门到精通系列》,即使是书,都是为了照顾新入门的准开发者们从零基础开始的,涵盖不了精通所需的很多东西。

Step3:起好标题

也许你听说过这个说法:标题是文章最重要的部分,严肃的作家花在标题上的时间和写文章的时间一样长。确实如此,因为选好标题不仅是选择文章切入角度的第一步,也是让我们能够牢牢抓住文章主题而不至偏题的护身符。

你要清楚,在任何一次沟通过程中,大多数的人都只对某一条信息感兴趣,因此一定要保证你提供给读者的信息只有这些能引起兴趣的事情。

Step4:简介与大纲

技术文章的一大特点是文章逻辑严密,层级分明。因此在写作之前,应先列好提纲,根据内容层级由浅入深。

如果是长文的话,最好先写个几百字的简介再列提纲,还要搭建框架。这样能把文章范围圈住,不容易跑题。

文章内容的范围不宜过大,写大而全的东西对作者的水平要求非常高且需要消耗大量精力。如果真想写,也请先把思路理清,与有经验的人交流之后再下笔。

Step5:具体写作

对于初学者来说,写作时容易跑题、枯燥、没有重点,这时候可以尝试提问与问答模式。

1.提问与问答模式

像知乎和百度问答里的文章就是经典的提问与问答模式文章。这种模式的优点很明显,首先,因为文章是用来回答问题的,不容易写跑题;其次,可以很好地把目标用户吸引过来;最后,读者很容易能抓住文章的要点和逻辑,阅读起来更轻松。

2.讲故事的方法

如果你能够逻辑清晰、主次分明地完成一篇文章,也可以选用其他模式来写,这里比较推荐讲故事的方法,用叙事的方式来讲述专业知识,更具温度和亲和力,让读者能轻松地读下去。

3.段与句

当然,你也可以选择适合自己的模式,无论什么模式一定不要写太长段落和句子。每个段落只讲一件事情,每句话不要超过40个字,能用短句不用长句。

4.特殊文章

另外,类似选型、对比、趋势一类的文章,对行业整体的把握也非常重要,在表达自己的观点之前,应该充分了解其它人的看法,尤其是和自己观点相左的看法。

5.代码与demo

大部分技术知识可以用代码讲清楚,那么此处务必贴出代码。代码应该结构清晰,逻辑简单,能讲清楚问题就好了。一些关键代码需要有清晰的注释。如果有 demo,可以放上 demo 的链接。

6.术语与配图

在对高深内容或者细节进行描述时,即使前文已对相关名词做出了解释,也不应该堆砌专有名词。尽量用白话或者类比的形式将问题解释清楚,文字叙述不清楚的地方,请作图。

总的来说,一篇优秀的技术文需要有:

  • 取好标题,醒目突出中心
  • 图文并茂,适当配图说明
  • 篇幅适宜,不宜过短也避免冗长
  • 格式统一,基本排版规则需要遵守
  • 细节处理,错别字标点处理正确。

加 51CTO 官方社群【微信号:CTO51shequn】,备注“写作”,拉您进技术人写作交流群。更多内容请点下方二维码学习《30问提升技术人的写作力》还能领取50元优惠券

作者简介

张瑞喜,毕业于北京邮电大学(原北京邮电学院)无线电工程专业,毕业后一直从事科技图书编辑出版工作30多年。2017年首届出版融合技术、编辑创新大赛年度大奖(最高奖)获得者。

【责任编辑:张昂 TEL:(010)68476606】

点赞 0
分享:
大家都在看
猜你喜欢

订阅专栏+更多

CentOS文件服务与数据管理

CentOS文件服务与数据管理

涨薪跳槽必备技能
共15章 | 追风蚂蚁

23人订阅学习

小白网工宝典

小白网工宝典

一次搞定思科华为
共15章 | 思科小牛

252人订阅学习

防火墙大佬修炼手册

防火墙大佬修炼手册

网工达人必备
共20章 | 捷哥CCIE

313人订阅学习

读 书 +更多

标准C++开发入门与编程实践

本书着重介绍标准C++语言,即1998年由ISO正式推出的关于C++的国际性标准版本。 本书从最基础的编程语言概念讲起,共分6篇24章。前4篇完整...

订阅51CTO邮刊

点击这里查看样刊

订阅51CTO邮刊

51CTO服务号

51CTO播客