前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >化繁为简,走出自己的技术写作之路

化繁为简,走出自己的技术写作之路

作者头像
BWH_Steven
发布2021-09-22 12:28:19
3290
发布2021-09-22 12:28:19
举报
文章被收录于专栏:理想二旬不止理想二旬不止

0. 时间线

2018.12

  • 踏上了 Java 学习之路

2019.02

  • 养成了 Word 记录笔记的习惯,随着接触到 Typora 记录 Markdown 格式文本的方式,我像是发现了新大陆,对它高效、整洁、兼容的风格爱不释手。

2019.05

  • 我创建了自己的公众号 “理想二旬不止” 和几个技术社区的账号 “BWH_Steven”,自己的分享,偶尔能被认可,满足之感油然而生,从此刻,我也开启了自己真正意义上的技术写作。

2021.01

  • 我在 GitHub、GitEE 平台创建了 Java-Ideal-Interview 项目,希望整理一份可以快速阅读/学习的 Java 后端的开源文章项目(自己归纳的知识问答 + 原创文章)。

1. 为什么写?

最近时不时就会有一丝恍惚,想问自己,技术写作的初心是什么?或许是为了记录,代表自己曾经来过,或许是为了积累和分享,给自己带来成就感,也或许它早已成为了一种习惯。 从21年上半年停更到8月底,忙碌之余我就在想,我的写作好像进入了为写而写的怪圈,像是完成一些定量的任务一般,所以文章的质量也忽上忽下。还记得我当时写作的初衷是希望文章对自己有帮助的前提下,还能对别人也有一些帮助。现在这种被动输出的诡异感觉,似乎在提醒我,该停一停了。 工作也好,学习也好,一股脑的向前冲是不理智的,你要时刻掌握自己思想的主动权,明白自己走的意义,及时选择自己认为正确的路,及时根据客观回响修正自己的方向。再将自己的热情投入,否则只是一腔热勇的傻小子罢了。 所以我停了下来,思考自己的路应该在哪里。

2. 是谁在博人眼球,又在贩卖焦虑?

2.1 流量密码

“限时领取,阿里技术专家内部资料 24 小时删除……”,“字节新宠火遍编程圈 ……”,“面试官问我做过什么项目,我这样回答……”。当你情不自禁的点击进去后,最后等着你的一定是一张大大的卖课/引流二维码。各种标题党、广告、营销手段,最终堆起一个又一个大 V,而让一些真正有实质输出的博主,淹没入铺天盖地的垃圾信息中。让读者也逐渐失去了兴趣,也让公众号技术类文章的权威性大大降低,毕竟公众号的最大便利在于基于微信,很方便,但却持续获取到的是一群没用给的信息,只会让人心生厌烦之心。

2.2 贩卖焦虑

客观的讲,一些比较大的培训机构对于入门某一块技术的时候,还是挺有帮助的。但是同样是因为各种营销的介入,培训班各种铺天盖地的系列框架,各种中间件,分布式,往往会让人心生畏惧。对于一个学生,一个刚入门的小白,看到这样的场景,总会给人带来各种焦虑。而与此同时,他们往往会把这些课程与就业、工资等敏感话题挂钩,给人一种只有学完这些东西,才能找到好工作,高工资。然后就会有无数的人投入到对框架技术的狂热之中。然后云里雾里的配一下环境,然后跑一些 Demo,就代表学会了。至于用在什么场景,为什么用,有没有更好的方案,也并不清楚。好像有一种学过,但是又没学会的感觉,也是徒增焦虑。

2.3 浪费时间

当你无论是百度还是谷歌一个问题的时候,首先展示给你的都是一些权重比较高的站点信息,例如 CSDN,博客园等等。但是这些大平台的数据实在太多了,优质答案肯定是存在的,但是 copy 的更多,点好几个页面进去都是同一份答案。更可恶的是,一些网站应该是用爬虫等自动爬数据,直接把文章导入到他们的网站,然后图片因为原网站防盗链,大部分还是失效状态,阅读感极差。最后的结果就是,例如搜索 “如何配置 XXX”,最后第一页往往是大量重复的无效信息。效率低下。

3. 我心中的技术写作

3.1 如何撰写优秀文章

我认为,优质文章(100%) = 技术(70%) + 文笔(20%)+ 美化(10%)。 从我的经验来看,随着学习而记录下来的内容,更准确的应该叫做笔记而不是文章。它更多的是对你个人学习过程的一个记录和备忘。如果作为文章来看,宽度和深度都一定程度上的不足。这也就是 “对自己有用,对别人没用” ,但是能做到这一步,我认为与你个人而言已经有很大帮助了。如果想要对别人也有帮助,就需要对这块的技术进行应用 + 深耕,只有自己切身体验过,研究过才能知其然,更知其所以然。 而文笔,就是你冲向终点的一把助力,拥有一定文笔的人,才能知道如何精炼的表达,如何在复杂的技术中寻找联系和结构,如何通俗易懂,简洁明了的描述这个技术。文笔使人阅读不枯燥,文字不晦涩,吸引你的读者继续阅读你的文章。 当然,必要的美化也是需要的,人都是视觉动物,排版的整洁,代码的高亮,图片的清晰度。都会直接影响到读者有没有读下去的心情,但是我想知道,美观大方 ≠ 花里胡哨,切莫为了美观而失去了技术的本质。

3.2 小册与专栏应该有所区分

很多时候,我们并不想深度的去阅读一些文章,我只想进行一些轻阅读,或者只想快速的找到答案,那么即使是长篇的优质文章,对于当事人来说也同属无用信息。这一点,其实很多社区,例如掘金,思否等等,都是有的。这一点也应该理应延续。

3.3 构建知识体系

你的脑海中知识要有体系,你的记录同样需要,但是随着你知识面变广,或者随着对技术点的深度挖掘,你的知识体系结构也在不断的扩容和修正,但是当你到达某一个阶段的时候,你似乎会发现曾经自己的知识结构对于现在的自己,似乎已经并不合理了。所以本地写作上,对于文件地址和结构的安排变更就会受到一定程度的影响,这也是下面在第四大点我会提到的。

3.4 可迭代

再补充一个概念——可迭代,可能大家会第一反应想到 GitHub,对的就是它的概念,我还记得在我刚上大二的时候,我一直有一个念头,我能不能开发一个可多人写作的知识管理平台,无论是组的概念,还是面向全部互联网的概念,这不重要,我只希望知识也可迭代。否则每次发布一篇完整的新的文章的成本和重复率就会比较高。如果可迭代,就能不断的完善修改这篇文章,从而拿到知识的最优篇。

4. 如何选择平台和方式

4.1 过去的方案

我可以给大家阐述一下这些年我用的最久的方案:

  1. 本地 Typora 编写文章
  2. 七牛云存储静态文件
  3. 文章发布平台
  • Hexo | Halo 发布博客
  • 掘金、思否、CSDN、博客园、知乎、开源中国、简书发布文章
  • 公众号:理想二旬不止,发布推文
  • GitHub + GitEE 发布 Java-Ideal-Interview 面试知识问答系列

接着我来分析一下利弊:

  1. Typora 编写 markdown 格式的文章,没的说,即时渲染的体验很好,不过文字量太大的时候偶尔会略卡,但是体验感仍然非常好。
  2. 七牛云做图床,有免费流量额度,超过后需要收费,整体还算可以接受。阿里腾讯云各自的对象存储都有不同的收费风格,不做比较。
  • 这几个知名的图床基本还是稳定的,不过我一般会本地存一版,再全局替换图片为图床地址图片一版。
  • 不过日后想要修改知识体系结构的时候,命名都是写死的,例如你用了 image.ideal-20.cn/javase-001.png 就会导致以后必须沿用这个地址。
  1. Hexo 建议喜欢折腾的人用,我部署在了服务器上,因为需要在本地自定义安装、配置很多东西,每次上传也需要通过命令。这个我用了很久,但是每次发布文章,要修改的地方不少,漂亮的主题图片会比较多,加载也慢,后来考虑换一个主题。Halo 后来也用过一段时间,主要是省事,Java 开源博客,有后台也有一些用户开发的主题可选,缺点就是标签和分类等维护也是麻烦。
  2. 直接发布在一些技术社区,好处很明显,文章阅读的流量高,与他人的交流也多,但是如果只是想记录一下点,并不成体系的话,像掘金思否等就不太合适。

4.2 新选择

首先,我试图摈弃掉本地笔记的写法,好处就是不再需要维护本地的各种文件,图床也不用考虑了,特别的是,修改结构似乎会变得简单一点。 接着,我考虑精简输出的平台,只保留个别,同时尽可能的简化非写作本身的繁琐步骤,回归写作本身。经过一段时间的比较,现阶段的写作平台和方式如下:

  • Notion 记录生活 + 笔记 + 计划 + 工作记录(非完全正式的部分梳理,记录等)。
  • 语雀 作为正式写作平台,打动我的点:访问/同步速度稳定 + 编辑界面舒适 + 支持 markdown + 结构标签等维护简单 + 图片内部上传(有流量限制,但是够用,如果体验好不介意充值会员)+ 分享方便,移动端小程序和链接体验也算良好。
  • 缺点也算是有的,例如 Mac 客户端占用资源较多,文字过多后,会有卡顿现象。不过还算在接受的范围内吧,希望能一直优化。
  • 是否重新搭建 Hexo 博客待考虑中(毕竟自定义化高)
  • 公众号|掘金|博客园 选择性发布文章,小记录等不算。

总之,最大的改变就是舍弃了过去本地笔记的写法,对比了多家平台,选择了语雀作为主力写作平台,或许阅读和访问的流量就没有以前那么高了,但是能够投入更多的时间和精力到写作本身,利大于弊。

本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2021-09-06,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 理想二旬不止 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 0. 时间线
  • 1. 为什么写?
  • 2. 是谁在博人眼球,又在贩卖焦虑?
    • 2.1 流量密码
      • 2.2 贩卖焦虑
        • 2.3 浪费时间
        • 3. 我心中的技术写作
          • 3.1 如何撰写优秀文章
            • 3.2 小册与专栏应该有所区分
              • 3.3 构建知识体系
                • 3.4 可迭代
                • 4. 如何选择平台和方式
                  • 4.1 过去的方案
                    • 4.2 新选择
                    相关产品与服务
                    对象存储
                    对象存储(Cloud Object Storage,COS)是由腾讯云推出的无目录层次结构、无数据格式限制,可容纳海量数据且支持 HTTP/HTTPS 协议访问的分布式存储服务。腾讯云 COS 的存储桶空间无容量上限,无需分区管理,适用于 CDN 数据分发、数据万象处理或大数据计算与分析的数据湖等多种场景。
                    领券
                    问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档