关于技术写作
周末读了张鑫旭大佬写的文章,感触颇深,记下随笔
引言
写作真的是一个对职业生涯发展很有益的事情,像什么呢,就好像英语和演讲一样,我们即使不会,也能写出来优秀的代码,也能升职加薪。但是如果我们技术不错,英语流利,不用我说,各位也都都能感知到好处之大。甚至说其作用不亚于我们赖以生存的工程技术。从我这个普通学历普通开发的个体来看,写作确实挺难的,就像在写这篇文章的时候一样,我好像悟到了什么,想写点什么,但是下笔时确不知道从何开始,在哪结束,更不用说把握文章让其拥有清晰的脉络了。那么如何写好一篇技术文章呢,确实是个值得深思的问题。本文从文章的标题、结构和内容出发探索下如何能写出一篇好文章。
性格
写作产出的文章风格,结构与内容暂且不谈,我们来聊一聊性格,性格与写作有什么关系呢?拿我个人来举例,敏感型人格,闷骚。
我总结出来以下我写作时的心理状态:
- 这样写太普通了,有点丢人。
- 这个技巧不太常见,我写出来应该有很多人看然后因为这个关注我吧。
- 一个知识点,因为想解释的足够清楚,写着写着越来越冗长生硬,想草草结束
- 我这篇文章被大佬看到了应该会被嘲笑吧,技术一般也想炫技
- 我好像一个小丑🤡
- 这个地方应该放一张动图来解释更好🤔,算了,太麻烦了,还是贴张图吧
- 写完之后(有些文章):文档/论文式文章,毫无温度,写完自己都没兴趣看,想了想,写都写了,还是发出来吧吧😂
我以前不是这样的,刚上大学那会随便拉个人过来都能砍大山一小时,更不会敏感,也不会闷骚,那会应该是真骚(bushi
经过思考和总结,应该是写代码太久的缘故,在我的认知中大部分的程序员应该和我有差不多的性格特征,欢迎👏各位讨论或者留下你写作时的心理状态,我们汲取好的,改进坏的。
话说回来我们在不是谈论写作吗,怎么聊到性格了,这是因为我觉得写好一篇文章的第一步就是改变性格,看到这里很多观众就要大笑了,"江山易改,本性难移",因为想写文章性格就要改变性格,别在这扯淡了,但是我这里说的性格是写作上的性格,我们可以通过心理暗示来改变自己写作前的想法,写作时的想法,写作后的想法,比如:
- 别人可能没你想的那么厉害
- 世界其实就是个草台班子
- 尽情展示自己吧,你是个有温度的人,你的文章也应该有温度。
- 保持高质量输出一段时间文章看看,不行就 崩 撤 卖 溜
- 我只和自己比,有进步就行
- 用心!
关于第四点,其实是个悖论,如果能保持一段时间高质量的输出,在这个扁平的互联网模式下,肯定会有正向反馈的,所以也不会崩 撤 卖 溜了,这里想表达的是写作本来就是个低门槛,没有及时反馈的事情。所谓千军万马独木桥,紫皇宫阙路遥遥。激情澎湃兴致高昂==>三天打鱼两天晒网==>铩羽而归摇头撇嘴都是很正常的事情,如果为此为此内耗和焦虑,就得不偿失了。
那么如何写好一篇技术文章呢?
麦克阿瑟说过:路选对了,就成功了一半🥳。
选择平台
第一步要做的肯定就是选择平台。平台分为自建平台和公共平台
自建平台就是我们个人网站,如张鑫旭大佬的个人博客就是属于自建平台,自建平台主打的就是自由,随便定制
公共平台指的是:微信公众号、知乎、思否、InfoQ、掘金、medium、简书、csdn、b站专栏、博客园、微博、头条号,百家号等,限制较多,但是平台能给你提供流量。
如果是小白建议先做公共平台,在公共平台上发表文章,多尝试不同的文章风格,确定有一个较高的阅读量的文章风格和内容之后在向自建平台引流。当然自建平台也可以作为你平时记笔记的地方。因为可以随便定制,所以有很多程序员还是比较喜欢自建平台的,自建平台也有一个好处就是它本身也属于一个作品嘛,面试的还是能够拿出来说一说的。
当然还有一种半自建平台也是非常非常不错的选择,如vitepress
,Wordpress
,简单,快速,逼格也不低,也是很多大佬的选择。
平台总结:
专业的技术文章推荐:知乎,思否,掘金、InfoQ,b站专栏,微信公众号
偏资讯娱乐阅读类的推荐:头条号,百家号,微信公众号
如果写作发展较好,公众平台和自建平台都是需要的,所以小孩子才做选择,而大人全都要。麦克阿瑟也说过:如果两条都走,那么定会成功的!
确定主题
接下来该写文章了,假定这里你才华平平,肚子里的墨水不多,技术也一般。那么恭喜你!你的竞争对手90%都是这样的人,你只需要提升1%,就站到了金字塔的上端成为那前10%。
是时候确定一个写作主题了! 不同的人有不同擅长的事情(废话),但也有人喜欢写自己不擅长的东西(较少),不管你是哪种人,关于写作的主题如何选择,有这么几点建议:
- 最好与本职相关
写的文章与本职相关更容易能反馈到本职工作中,通常你会为了写一篇文章,耗费很多精力去查阅资料佐证,在这个过程中有助于我们提高本职本职工作的能力,可能会用于项目总结汇报,公司技术分享,提出技术方案,而这些能够在某些方面帮助我们升职加薪,或者更好的跳槽,也可能是让我们在寒冬中多了一分竞争力!总之互惠互利。但是也不尽然,此处应扬己所长,避己之短。
- 尽可能的垂直
我们个体的精力是有限的,但是社会的发展非常迅速,在技术领域中,入门教程,进阶教程不管是文章还是视频早已如过江之鲫,数不胜数,在网上看到了一篇还不错的文章在几天后,你能想起文章内容,但是能想起作者是谁吗?但是如果你在细分领域中产生一定的影响力,那就不一样了,以卡颂在react源码这个垂直领域的影响力来举例,可以想象到这么一个场景:同事A给同事B解聊天想研究下react源码,同事A给同事B说"看react我强推卡颂,我看过很不错",同事B说"卡颂我也听说过,给我个课程链接我去看看简介和目录。",这就是在细分领域产生的心智垄断,具体可以看卡颂大佬的这篇文章。在垂直领域的持续输出能让自己写文章的价值最大化。
总之,写作的主题尽可能围绕这两点结合自己的特长选出来一个。
头像和名称
确定好写作主题之后,那就打开平台网站,开始写作吧,是不是忘了些什么,作为一个要认真写作的人,头像和名称也是要考虑下的,不能上来就是小张前端,小王后端,小李运维这种太随意的名字,头像也最好不要选一个很大众化的头像,因为这是要随着你一直走下去的,文章内容可能在变,头像和名称最好不要随便变动,这也是算是你的辨识度。现在它们就是你这家一人公司的logo和名称,花点时间好好选择,好了,名称和头像整好了那就让他们全平台一致吧!
文章选题
在选择好了平台、头像、名称,写作的主题之后下面就开始选题了。选题这件事情对于大部分人来都比较简单,因为当你想写一篇文章的时候,你是已经知道了自己要写什么了。
例1: 当我在工作中遇到了一个棘手的问题,发现了这是javascript
中继承的一个坑,你想写一篇文章出来,那么你的文章主题就是我想写关于javascript中继承的知识点
。
例2: Typescript
新版本发布,你想快速出手,写了一篇关于新版本发布内容的文章,这种文章就算比较一般也会获得很高的阅读量。那么你的文章主题就是我想写关于Typescript新版本的内容
选题推荐:日常工作中的小技巧,小创新;深入理解XXX,XXX原理剖析;体现技术深度的棘手问题解决;
好家伙,搞了半天关于写作的内容是一点没说🤣, 不要急,马上就开始了! 在写作之前有一个小技巧分享给大家,在确定主题之后,我们可以先在搜索引擎上搜索关于主题的信息,查看关于该主题的文章,然后还可以问chatgpt,让chatgpt化身该主题的super专家, 让他帮你列大纲。但是需要注意的是,我们不能完全信任chatgpt,所以需要一点时间去辨别chatgpt给你信息的可信度,不过就算是这样,也能给你足够多信息的和注意事项了。
文章阅读量关键: 标题
标题就像一个人的外表,没人愿意通过你丑陋的外表来了解你"有趣的灵魂",当然如果你是马云那我相信会有不少人想去了解马老师有趣的灵魂的,在技术文章中,一些超级大佬写的文章即使标题再简陋,仍然被视若珍宝。但是很多""技术人员"都没兴趣或者没时间去分享他们的知识。所以当你有写作的想法并稍作坚持,那么其实就过滤掉一大批人了。吸引人的标题会更有可能让读者阅读、点赞或参与到文章中。
夸大其词,刻意煽动情绪的文章标题并不可取,例如: 《props的含义无人解释清楚,快去请尤玉溪公子》, 《震惊,尤大看了我的pr竟然流下眼泪》,这样的标题与文章内容通常悬殊过大,使用标题将用户诱导进去,但是内容平平, 其他的领域不清楚,但是在技术领域中,读者通常会对文章的内容要求很高,他想看到有趣的内容,获得有价值的内容。写作是一个买方市场,你可以欺骗用户一次,但是也就这一次了。
那么怎么是一个好的标题呢?
- 这里也有个小技巧,就是可以给这篇文章写10个标题,然后挑选出来最好的一个。
下面是写好标题的一些建议:
-
标题和内容要有一致性,不要在标题中承诺某些东西,但是在文章中却没有做到。
-
在标题中最好包含具体的数字,具象化我们想表达的概念,
-
好的例子:
我是如何通过写文章每月赚到3000元
-
不好的例子:
我是如何通过写文章赚钱
-
-
结合搜索引擎。
- 搜索与你写的主题相关的在搜索引擎中高排行关键字,你也加上,通过搜索引擎的来源会是很大一部分的阅读量。
-
擅用chatgpt进行增强
-
添加俏皮的表情符号🥳
举个好例子: 性能优化:我通过这个简单的技巧让网站首屏打开速度提升30%!。这里使用了数字将性能优化这个比较"宽泛"的概念具象化,"简单"二字变向的设置悬念。
还有用疑问句式写标题也有很好的效果如:
- 为什么? [性能优化]:为什么这么简单的技巧能让网站首屏打开速度提升30%?
- 如何/怎么? [性能优化]:我是如何通过这个简单的技巧让网站首屏打开速度提升30%?
- 质问: [性能优化]: 这些优化网站首屏加载速度的技巧你掌握了几个?
- 对比质问: chrom性能优化指标众多指标中为什么这个指标对首屏加载速度如此重要?
在漫如烟海的博客中,读者会通过标题来判断是不是值得点进去,花点时间把握下这个入口节点吧。
文章结构
经历了重重困难,我们现在可以搭建文章的结构了,以我自己写文章的时候来举例,脑海里没有文章结构这样的概念,都是想到哪写到哪,只要每一段的逻辑偏离的不是很离谱,都不会刻意去修正。但是好的文章结构能更好的促成你的文风, 提高你的辨识度。
我总结如下的基础结构(一般文章可以直接套):
-
简单介绍
- 简单介绍也可以称之为引言,引言部分切忌不可太官方,如这篇文章我们将介绍xxx知识点,1. 2. 3. 4.....,或者像这样:在这个快速发展的行业里....这种通用的风格开头,那么或许你会损失掉很多已经点进来的读者。
- 引言和标题差不多,尽量活泼一些,或者用阴谋一些引起悬念。可以用数字说明文章的重点,减少读者思考时间,也可以用疑问句进行自问自答的形式,让读者心中有数。
-
介绍和说明
- 介绍和说明是整个文章的基础, 通常我们会介绍文章主题的背景,知识点的基本操作。添加插图来增加文章的可读性。
- 文字保证前后连贯,内容重点突出。
-
实际案例
- 这是文章的核心部分,引言是说服读者开始阅读文章, 介绍和说明提供了背景知识,而实际案例是给读者带来价值的地方。
- 添加小标题来帮读者识别到主要的部分, 这里也可以尝试邀请读者去阅读你的另一篇与此内容相关的文章,一是体现你对该领域的专业度,二是并不是每位读者都会读到最后,你可以试着在中途把读者导入的你其他的优秀文章/视频中。
-
总结和扩展
- 总结的阶段你可以表达自己的观点,提出自己的看法, 可以让读者引起讨论,每篇文章结束的时候最好都带有一句标识性的话,比如灰太狼的"我还会回来的", 这对塑造我们个人品牌很有帮助。
- 总结这个地方很多人都喜欢加上链接或者二维码之类的,我认为最好不要,除非和这篇文章的联系度非常紧密,对读者很有帮助。
以上只是大体的介绍了文章的一些基本结构,如果我们没有特别好的点子,可以按这个模式来套。读者看的清晰,自然不会吝啬手中的额赞的。而且有些时候写文章想获得高阅读量的原因也不仅是我们可能会获得更多好处,二是因为我们在写作上投入了大量的时间、经历,只是希望人们阅读它而已。如果看到这里,请点个赞吧[比心❤️]。
配图
配图很重要,所谓一图胜千言,文章中一大段一大段的文字,看了也没啥食欲,适当的增加配图不仅可以增加一些视觉冲突感,缓解读者的疲劳感,而且有些概念用流程图/代码贴图解释起来比文字太清晰了。
截图工具:FastStone Capture(Windows)、 iShot(OS X 系统)、微信/qq自带的截图工具。
绘制图形:figma.com/jam
总结
写作其实没有固定的套路可言的,我们其实平时可以有意识的留意下平台的文章热榜,看看这些热榜的标题、结构、配图,吸取他们的优点记录下来,自己平时在工作生活中产生的灵感一定要记下来,这些灵感可遇不可求,慢慢的积累下来肯定会变成一个写作高手。而且最重要的一点是要用心,清晰的解释,合理的代码,用心做的代码/逻辑图片,读者不是傻子,他们会看到的用心,这比什么方法论或者套路都有用多了。写到这里,反复读了几遍, 总还是感觉有很多地方写的不是很好,但是,写都写了,那就发出来吧🤣[狗头]