【全方位解析】如何写好技术文章

前言

为何而写
  • 技术成长:相对于庞大的计算机领域的知识体系,人的记忆还是太有限了,而且随着年龄的增大,记忆同样也会逐渐衰退,正如俗话所说"好记性不如烂笔头"。并且在分享博客的过程中,我们也可以和大神交流,进而发现自己的认知错误,纠正知识体系。最后最重要的就是通过记录博客,我们可以及时总结归纳,通过写作来梳理思路,查漏补缺。
  • 增大影响力:在当今世界,如果要谈论什么最有价值的东西,那无疑是影响力。网红和明星之所以能赚大钱,就是因为他们拥有巨大的影响力。在这个竞争激烈的时代,拥有强大的影响力的人,就是真正的胜利者。而写作无疑就是一个扩大影响力的工具。
  • 工作机会:在求职过程中,博客的作用也不容小觑,博客本身就是一个非常好的自我展示的平台,通过向面试官展示自己的技术广度和深度,可以让你比大多数求职者领先一步。
  • 额外收入:在自己博客/公众号租赁广告位,或是投放公司内推广告,抑或是写作平台签约写手,或是借助影响力写书卖书

一、明确自身技术定位和受众

首先就是明确自身的技术定位,比如说我专研前端技术,那么博客的技术选题也要围绕此方向,从而营造个人IP,这里顺便说下选题

技术文章选题很多,这里大致分为以下几种:

  1. 新方法/新技术的布道:比如 JS 新特性,或者新的构建工具等等
  2. 技术方案总结类:比如弱网环境下的加载优化机制等等
  3. 优秀框架的体验指南:比如 react SSR 从 0-1 的过程等等
  4. 自己觉得很厉害的小技巧:比如一些独特的优化手段,JS 的黑魔法等等
  5. 原理剖析类:比如 XXX diff 原理等等
  6. 棘手问题的解决方案:比如CDN 被劫持的解决方案

其中前 3 点是比较适合新手同学入手的,可以根据自己的实际情况从这些点去做切入。可以从caniuse寻找新技术点

其次要明确写作目的,受众人群。也就是给博文定调,是轻松幽默、力求详尽,还是严肃认真、专业概括,亦或者其他风格。

自己看,就是随笔,个人笔记。可以随笔写,甚至可以是一句话,一张图。完全可以是自嗨文。

技术分享,这时就要考虑全面,不能写成自嗨文,要有一定的套路,要明确受众是哪些群体,是小白,还是高手,或者是领导。根据受众的喜好和自己的能力圈适当发挥。

约稿,一般情况甲方都会给一定的格式和要求,再结合技术分享的经验成稿。

自嗨文:网络流行词,就是调子很高,辞藻华丽,但没站在用户立场上写的文章。

二、选择合适写作平台

  • CSDN:国内最老牌的博客论坛,seo做得很好,用户量很大,但是文章质量一般不高,并且广告多,用户体验不好
  • 博客园:和CSDN同样属于老牌博客网站,具有良好seo,同时不乏优质博客,但是写作体验差,样式老旧(但是可以自定义美化)
  • 掘金:平台新,写作体验很棒,界面清爽,官方经常发布活动针对优秀写作者提供物质奖励
  • 腾讯云/阿里云社区:大牛专场,文章质量没得说,但不太很适合新手
  • 知乎/简书:两个平台均不是专门的技术网站,但是文章质量都比较不错,seo权重高,可以适合引流
  • 公众号:主要就是要把其他平台的流量进行引流,适合长期经营
  • 独立建站 :相对来说比较麻烦,但是比较自由,需要针对seo优化,大牛博客:张鑫旭阮一峰廖雪峰

三、如何给文章起标题

平均而言,阅读标题的人是阅读正文的5倍- ------ David Ogilvy

其实标题的重要性主要有两个,一是 SEO(搜索引擎)优化 ,二是提升读者阅读体验

标题关键点

1、简单

我阅读过关于文章标题的讨论基本都同意文章的标题要简单、简短和容易理解。如果违反这原则,你也能获得注意,这是那种困惑、不知所措的注意。短标题同样利于搜索引擎优化---标题要短于40个字符,这样可以确保标题全部出现在搜索结果中。

2、吸引注意力

好的标题能够让你的文章脱颖而出并吸引读者阅读。吸引注意力可以通过使用产生"震惊"、"呼吁"、"意外"甚至"困惑"效果的文字。这些文字可以吸引读者进入正文阅读,尽管可能是标题党的文不符题。尽可能用标题吸引读者,哪怕是利用一些小伎俩。

3、满足需求

好的标题可以让读者进入正文,就是因为读者认为有满足他们需求的内容。索引网站http://del.icio.us的一项调查表明,最吸引读者的标题通常都是"如何..."或者"...的教程"这类文章吸引读者,因为他们想解决遇到的相关问题。

4、直观

尽管许多读者也会被那些含糊的标题吸引进入正文,但是大多数读者都是喜欢直观的标题,便于决定是否进行更多的了解。标题应该简短直观表明正文的主要内容。

5、关键词

在本文前面我提到标题对于SEO的重要性,所以,如果你想充分利用这个作用,你需要思考如何选择更容易被关注的关键词。看起来标题又要简洁又要引人注目难以两全,但是还是可以做到的。比如,SEO中,标题前面的词组作用比后面的更有效果。

补充:如何撰写开头介绍/摘要

标题的作用是让读者开始阅读第一句 。文章开头的任务是把读者吸引住并让他们继续读你的文章

开头介绍遵循APP公式 ,即匹配需求(A lign),展示(P resent),效果证明(P roof),示例

首先,我们匹配需求(A lign)。用1至2句话,给你的用户展示你理解他们面临的问题。

接下来,展示(Present)你的文章作为解决方法。

告知他们你已经发现了该问题的解决办法。或在不泄露所有内容的前提下,也可尽量简短地解释这种方法。"喂食"人们一些内容,让他们可以继续看下去。

最后,给出我们的效果(Proof)证明。

这里你可以解释为什么他们要相信你。毕竟,你的访客很可能是第一次看你的博客或个人网站。你不得不证明你的成功,经验和专业。

四、搭建文章框架结构

有时写着写着就写不下去了。如果提前搭好框架,做成思维导图 ,就会轻松很多,不至于写到一半卡壳。技术博客一般结构都是总-分-总。下面是一些我自己用的模板分享出来,做抛砖引玉用,各位如果有其他模板不妨分享出来,我们共同进步。

  • 提出问题->分析问题->解决问题->总结经验,技术问题分享。
  • 背景->思考->尝试->遇到的困难->解决方案->最后结果,问题分享
  • 摘要->简介->分支主题->总结,一般技术分享。
  • 是什么-原理-背景>解决了什么问题->基本操作->同类对比->总结 ,适合新技术分享

五、制作配图及相关素材

draw.io:在线的画图工具,非常强大,内置了各种常用的元素和图标。

excalidraw:一款手绘形式的开源画图工具,无需登录,直接在网站上就能画图,可以很方便的导出文件,退出重进后,还会显示上次退出时画的图,非常方便,而且可以导入别人画的模块。但是不支持中文手写体,这里是支持中文手写体的网址

六、如何写出更有吸引力的内容

易于阅读

没人喜欢阅读。他们只想要信息。如果他们能下载这些信息到大脑里面,他们就将会这么做。------ Tim Soulo

首先我们要做的就是如何是我们的文章易于阅读,推荐 Bond Halbert 的书 The Halbert Copywriting Method Part III,下面是简单总结

  • **使用短段落。**Bond称这可以"缓解眼睛"。大量的文字会阻碍读者阅读,但短段落可以邀请他们来。类似Hemingway等工具可以使它变得更容易。
  • **分解长句。**人们通常会跟着大脑里的声音阅读。因此,长句会使阅读很难跟上。通过在用"并且"、"因为"、"这"的地方找到实列来分解句子。
  • **插入多媒体。**视频,图片,动图等可以在无需增加文字的情况帮你阐述观点。
  • 使用文字格式。 粗体,斜体,引用或者列表来分解大量的内容并可以强调特定的点。
  • 大声朗读你的文章。 这有助于你发现不太流畅或者无聊的内容。

表达形式

技术文章不一定就是一篇议论文或者是叙事文,可以探索更多的表达形式

  • 漫画类,比如程序员小灰,诙谐幽默,很有代入感
  • 微信 / 钉钉聊天框类,阅读体验也不错
  • 同人小说类,例如《JavaScript 百炼成仙》
  • 碎碎念文章,类似于张鑫旭大佬的文章风格,这种文章配合一些日常的段子啥的,也能起到非常不错的效果

换位思考

在写完一篇文章以后,并不代表你的文章就已经可以发布或者推广了,因为我们更多的是站在自己主观的角度来写的,所以为了保证文章的易读性,你还可以从以下几个方面去换位思考一下:

  • 如果我是个小白,这篇文章我能看懂吗?
  • 如果我不认识文章中的缩写词,我能理解这篇文章吗?
  • 我这里要不要加个架构图做说明呢?
  • 我这里要不要加个演示图做展示呢?
  • 我这里要不要加一下代码注释呢,万一对方是个初学者怎么办?
  • ...

同时还有一个技巧特别重要,就是把自己的文章多读几遍,早上睡醒的时候读一下,晚上睡觉前读一下,说不定读着读着,你的灵感又来了,同时还能发现不少错别字

参考文章:

技术博客写作指北------素材、排版和配图 (jiekun.dev)

技术文章写作指南 - KubeSphere 开发者社区

大神都在用的技术博客写作指南,首次公开,建议放枕边 - 掘金 (juejin.cn)

博客文章标题如何写? - 知乎 (zhihu.com)

如何写好技术文章------若川

推荐阅读

实战有效的17个博客运营技巧(新手必备) (ahrefs.com)

9 个技巧标题技巧,打造高点击率的博客页面 - 灵蹊社区 (getlingxi.com)

我是如何写好一篇技术博客的 - 掘金 (juejin.cn)

阮一峰: 中文技术文档的写作规范 (github.com) ------ 强烈推荐!!!

寄语
  • 如果你永远在等好的主题,好的灵感,可能你这辈子都敲不出来一篇文章
  • 不要有功利心,少写 XXX 面试指南,多写真实的 case、感悟
  • 保持自己的风格,维持自己的人设
  • 思考当下,思考一切

本文部分图片来自 Wikipedia

相关推荐
我命由我1234511 天前
写作词汇积累:差池、一体两面、切实可行极简理解
经验分享·笔记·学习·学习方法·写作·阅读·中文
程序猿k哥7 个月前
给程序员的10堂写作课(一)--30+的你,怎能错过写作?
写作
AI棒棒牛9 个月前
如何水出第一篇SCI:SCI发刊历程,从0到1全过程经验分享!!!
写作·sci
Time_Memory_cici10 个月前
IEEE Transactions on Industrial Electronics工业电子TIE修改稿注意事项及提交须知
写作
小二李10 个月前
第4 课-如何收集素材?如何保护好自己的灵感?
写作
easylee1 年前
如何写好技术文档 - 排版格式和规范(一)
写作·技术文档
ZHOU西口1 年前
谈谈如何写作(一)
写作·表达·沟通·汇报
天寒心亦热1 年前
英文科技论文写作与发表-精简写法和“Chinglish“(第4章)
写作·科技论文·英文