阅读 1520

7年技术写作,分享6点心得体会

2021 年 8 月 21日,阿宝哥很荣幸收到掘金的邀请,作为直播嘉宾参加《创作者训练营第三期》分享活动。直播中张鑫旭、Winter 和郑晔大佬们,分享了很多技术写作的干货。第一次参加大型的对外技术分享活动,刚开始的时候,阿宝哥还是会有些紧张。不过在掘友们的支持与鼓励下,阿宝哥最终也顺利完成了分享。这里再次感谢参会的朋友们,特别是活动前期帮忙分享此次活动的 “老铁们”,感谢有你

heart.jpeg

接下来,阿宝哥将以文字稿的形式,总结一下《7 年技术写作,分享 6 点心得体会》PPT 分享的内容,将从 突破自己、如何选定写作主题、如何开始写作、写作技巧与写作建议和写作辅助⼯具 5 个方面展开介绍。

一、突破自己

在刚开始写作的时候,阿宝哥没有搭建自己的博客平台,而是直接使用 Github.IO 来写博客。之后也“混”过多个主流的技术社区,但目前最主要的技术写作平台是掘金。我觉得人最大的敌人就是自己,写作的第一步就是要 突破自己

在写作之初,相信一些小伙伴跟我一样,会有以下困惑:

  • 写的文章太简单了,觉得对别人没有启发;
  • 写的文章太 “烂” 了,害怕会被别人吐槽;
  • 文笔不好,不知道怎么下手;
  • 想写的话,又不知道写什么内容;
  • 辛辛苦苦写的文章,又没有人看。

不知道你们在开始写作的时候是否也有以上的困惑,以上这几个问题曾困扰过我一段时间,之后在不断的写作过程中,我找到了自己的写作初衷 —— ”做技术沉淀“ ,于是写作也就慢慢坚持了下来。

我们公司前端团队中的一些小伙伴此前也有和我聊过一些写作方面的困惑,他们不知道写什么内容,也不太敢尝试写作。后面我就以技术分享的形式,来推动他们写作。我会定期选择一些技术分享专题,比如 设计模式专题、Webpack 专题和 Vue2 源码专题,然后让他们每个人都去准备对应的分享内容和对应的技术文章,接着让他们在组内进行分享,参加分享会的同学会对分享的内容进行打分,最终我们会评选出每次分享会的前 3 名,给出一定的奖励并且会在公司内部平台进行宣传。通过这种方式,让他们踏出第一步,慢慢养成写作的习惯。

近一两年来,我在技术写作上的一些收获。曾获得 2020 年掘金年度人气作者第 10 名、掘金首批签约作者,掘金 Lv6,文章百万阅读。2020 年利用业余时间我写了《重学 TS》、《前端进阶篇》和《源码探秘篇》等电子书,下载 5W 余次。在掘金等技术社区发布了《跟着阿宝哥学前端》、《Angular 修仙之路》专栏,其中 《Angular 修仙之路》是 2017 年开始写的,那时候国内 Angular 的文章还比较少,我就通过文章的方式记录了自己的学习 Angular 的过程,写了上百篇的文章。

二、如何选定写作主题

这里我会给大家分享一些选题的方向:

1、记录某个项目的踩坑经历或项目实战/优化经验;

2、记录你对某些面试题的剖析与思考;

3、分享算法的一些刷题或解题心得;

4、分享阅读某个开源项目的收获;

5、记录阅读经典书籍,比如前端方面的 “红宝书”、“绿皮书” 或 “犀牛书” 的学习笔记;

6、总结学习某些技术或计算机基础知识的相关内容;

7、分享某个项目的技术架构或核心功能的设计与实现;

8、分享个人的成长经历、面试经历等。

而其他的写作方向,大家可以参考技术社区的文章排行榜或分析你所关注的技术大佬,也可以找到一些写作的主题。比如通过掘金首页 —— 推荐栏位,就可以看到 热门、最新和热榜 的文章:

通过分析这些热榜文章,你就可以找到一些写作热点。另外,我的 QQ 邮箱有订阅一些不错的 Weekly。比如:JavaScript Weekly、Node Weekly、TypeScript Weekly 和 React Status 等。这些 Weekly 每周会推送一些不错的文章或开源项目。这些 Weekly 提供的信息,也是我选题的一些素材来源。

三、如何开始写作

在确定好写作主题之后,我建议大家先不要急着动手写,可以先列出文章的大纲,这样可以让后续的写作过程更加顺畅。其实这跟平时写代码类似,想清楚后再开始写代码,效率会更高。这里我以 你不知道的 Web API 系列文章为例,来分享一下我写 Web API 文章时写的大纲。

在写 你不知道的 Web API 系列时,我整理了一份通用的大纲。比如:

  • XXX 是什么/什么是 XXX
  • 了解 XXX API
  • XXX API 应用场景
  • XXX API 与相关知识点的区别

今年有幸成为掘金的首批签约作者,在写首篇签约文章的时候,我也在纠结到底写什么文章。后面突然想起之前看到掘金上 浪里行舟秋风 大佬写的跨域文章。这两篇文章总结了我们工作中, 跨域问题的多种解决方案和实现原理。

受到这个的启发,我就想到了日常工作中,文件上传的场景。所以我就先根据以往的经验,梳理了文件上传、多文件上传、拖拽上传和剪贴板上传的场景。之后,我就使用 文件上传 关键字,在掘金、谷歌、百度等平台上搜索相关文章,进而不断完善大纲。在初步整理完大纲之后,我就会对大纲的内容进行二次加工,比如进行筛选和排序。

在确认好大纲之后,为了保证文章的一致性。我又对每个场景的结构进行梳理。比如把单文件上传、多文件上传和目录上传场景拆分成 前端代码服务端代码 两部分内容来介绍。在确认完文章骨架之后,后面写作起来就会清晰很多。

掘金社区的掘友们还是很给力的,除了对文章的内容提出建议或反馈问题之外,还会帮你选题,甚至标题都给你想好了。

既然掘友有要求,连标题也帮我想好了,所以后面我又写了一篇 文件下载,搞懂这9种场景就够了 的文章。在写作的过程中,同样也是先梳理大纲,然后再对大纲进行二次加工。等文章脉络清晰了之后,才会动手开始完善文章中每个章节的内容。

四、写作技巧与写作建议

4.1 写作技巧

4.2 写作建议

1、多写专题的文章,后期就可以方便地整理成电子书或小册。如果写得好的话,还可以联系出版社出书。比如前端进阶篇电子书,我包含了 玩转系列你不知道的系列一文读懂系列。而重学 TS 1.0 电子书我包含了设计模式专题的文章。

2、写文章,多画图。特别是源码分析的文章,这样可以帮助读者更好地理解核心的流程。比如之前写 JavaScript 中如何实现大文件并行下载Axios 如何取消重复请求 文章时,我就画了对应技术方案的流程图。

3、尽量减少读者不必要的操作,为引用的内容添加快速链接。

4、如果是自己写的可执行代码,最好能运行一下,保证一下代码的正确性和可用性。更近一步的话,可以搞个专门的项目来管理。比如在写 文件上传,搞懂这8种场景就够了文件下载,搞懂这9种场景就够了 这两篇文章时,我就把文章中使用的示例代码统一放到 Github 仓库中。

五、写作辅助⼯具

俗话说得好,工慾善其事,必先利其器。最后我来分享这些年使用过的一些不错的写作辅助工具。

5.1 Markdown 工具

5.2 绘图工具

5.3 源代码处理工具

5.4 其他工具/资源

当然好用的在线资源还有很多,这里我在继续分享一些其他的工具、资源。

1、免费正版高清图片素材库:pixabay.com/zh/

2、免费和图片和影片库:www.pexels.com/zh-cn/

3、稿定设计:www.gaoding.com

4、在线图片设计:www.canva.cn/

5、阿里妈妈矢量图标库:www.iconfont.cn/

6、配色网站:coolors.co/

7、在线流程图思维导图:www.processon.com/

8、飞书:www.feishu.cn/

9、图床工具:github.com/gee1k/uPic

10、在线工具集:tool.lu/

总结

本文阿宝哥分享了 7 年技术写作,自己总结的 6 点心得体会,希望对大家能有所帮助。如果你在写作上有其他困惑的话,欢迎跟阿宝哥一起交流。此外,如果你有其他好的工具或资源的话,可以给通过留言的方式,分享给大家哟。

文章分类
前端
文章标签