From 932a7b0bb727fc0aa712d25d1cc0213a2c6cf3a6 Mon Sep 17 00:00:00 2001 From: Guide Date: Sun, 9 Apr 2023 20:42:14 +0800 Subject: [PATCH] =?UTF-8?q?[docs=20add]=E5=9D=9A=E6=8C=81=E5=86=99?= =?UTF-8?q?=E6=8A=80=E6=9C=AF=E5=8D=9A=E5=AE=A2=E5=85=AD=E5=B9=B4=E4=BA=86?= =?UTF-8?q?!?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/.vuepress/sidebar/about-the-author.ts | 1 + .../writing-technology-blog-six-years.md | 173 ++++++++++++++++++ docs/readme.md | 1 + 3 files changed, 175 insertions(+) create mode 100644 docs/about-the-author/writing-technology-blog-six-years.md diff --git a/docs/.vuepress/sidebar/about-the-author.ts b/docs/.vuepress/sidebar/about-the-author.ts index fe8b49db..c501a957 100644 --- a/docs/.vuepress/sidebar/about-the-author.ts +++ b/docs/.vuepress/sidebar/about-the-author.ts @@ -16,6 +16,7 @@ export const aboutTheAuthor = [ icon: "chat", collapsable: false, children: [ + "writing-technology-blog-six-years", "my-article-was-stolen-and-made-into-video-and-it-became-popular", "dog-that-copies-other-people-essay", "zhishixingqiu-two-years", diff --git a/docs/about-the-author/writing-technology-blog-six-years.md b/docs/about-the-author/writing-technology-blog-six-years.md new file mode 100644 index 00000000..5583b5a2 --- /dev/null +++ b/docs/about-the-author/writing-technology-blog-six-years.md @@ -0,0 +1,173 @@ +--- +title: 坚持写技术博客六年了! +category: 走近作者 +tag: + - 杂谈 +--- + +坚持写技术博客已经有六年了,也算是一个小小的里程碑了。 + +一开始,我写技术博客就是简单地总结自己课堂上学习的课程比如网络、操作系统。渐渐地,我开始撰写一些更为系统化的知识点详解和面试常见问题总结。 + +![JavaGuide 首页](https://oss.javaguide.cn/about-the-author/college-life/image-20230408131717766.png) + +许多人都想写技术博客,但却不清楚这对他们有何好处。有些人开始写技术博客,却不知道如何坚持下去,也不知道该写些什么。这篇文章我会认真聊聊我对记录技术博客的一些看法和心得,或许可以帮助你解决这些问题。 + +## 写技术博客有哪些好处? + +### 学习效果更好,加深知识点的认识 + +**费曼学习法** 大家应该已经比较清楚了,这是一个经过实践证明非常有效的学习方式。费曼学习法的命名源自 Richard Feynman,这位物理学家曾获得过诺贝尔物理学奖,也曾参与过曼哈顿计划。 + +所谓费曼学习法,就是当你学习了一个新知识之后,想象自己是一个老师:用最简单、最浅显直白的话复述、表达复杂深奥的知识,最好不要使用行业术语,让非行业内的人也能听懂。为了达到这种效果,最好想象你是在给一个 80 多岁或 8 岁的小孩子上课,甚至他们都能听懂。 + +![教授别人学习效果最好](https://oss.javaguide.cn/about-the-author/college-life/v2-19373c2e61873c5083ee4b1d1523f8f5_720w.png) + +看书、看视频这类都属于是被动学习,学习效果比较差。费曼学习方法属于主动学习,学习效果非常好。 + +**写技术博客实际就是教别人的一种方式。** 不过,记录技术博客的时候是可以有专业术语(除非你的文章群体是非技术人员),只是你需要用自己的话表述出来,尽量让别人一看就懂。**切忌照搬书籍或者直接复制粘贴其他人的总结!** + +如果我们被动的学习某个知识点,可能大部分时候都是仅仅满足自己能够会用的层面,你并不会深究其原理,甚至很多关键概念都没搞懂。 + +如果你是要将你所学到的知识总结成一篇博客的话,一定会加深你对这个知识点的思考。很多时候,你为了将一个知识点讲清楚,你回去查阅很多资料,甚至需要查看很多源码,这些细小的积累在潜移默化中加深了你对这个知识点的认识。 + +甚至,我还经常会遇到这种情况:**写博客的过程中,自己突然意识到自己对于某个知识点的理解存在错误。** + +**写博客本身就是一个对自己学习到的知识进行总结、回顾、思考的过程。记录博客也是对于自己学习历程的一种记录。随着时间的流逝、年龄的增长,这又何尝不是一笔宝贵的精神财富呢?** + +知识星球的一位球友还提到写技术博客有助于完善自己的知识体系: + +![写技术博客有助于完善自己的知识体系](https://oss.javaguide.cn/about-the-author/college-life/image-20230408121336432.png) + +### 帮助别人的同时获得成就感 + +就像我们程序员希望自己的产品能够得到大家的认可和喜欢一样。我们写技术博客在某一方面当然也是为了能够得到别人的认可。 + +**当你写的东西对别人产生帮助的时候,你会产生成就感和幸福感。** + +![读者的认可](https://oss.javaguide.cn/about-the-author/college-life/image-20230404181906257.png) + +这种成就感和幸福感会作为 **正向反馈** ,继续激励你写博客。 + +但是,即使受到很多读者的赞赏,也要保持谦虚学习的太多。人外有人,比你技术更厉害的读者多了去,一定要虚心学习! + +当然,你可以可能会受到很多非议。可能会有很多人说你写的文章没有深度,还可能会有很多人说你闲的蛋疼,你写的东西网上/书上都有。 + +**坦然对待这些非议,做好自己,走好自己的路就好!用行动自证!** + +### 可能会有额外的收入 + +写博客可能还会为你带来经济收入。输出价值的同时,还能够有合理的经济收入,这是最好的状态! + +为什么说是可能呢? **因为就目前来看,大部分人还是很难短期通过写博客有收入。我也不建议大家一开始写博客就奔着赚钱的目的,这样功利性太强了,效果可能反而不好。就比如说你坚持了写了半年发现赚不到钱,那你可能就会坚持不下去了。** + +我自己从大二开始写博客,大三下学期开始将自己的文章发布到公众号上,一直到大四下学期,才通过写博客赚到属于自己的第一笔钱。 + +第一笔钱是通过微信公众号接某培训机构的推广获得的。没记错的话,当时通过这个推广为自己带来了大约 **500** 元的收入。虽然这不是很多,但对于还在上大学的我来说,这笔钱非常宝贵。那时我才知道,原来写作真的可以赚钱,这也让我更有动力去分享自己的写作。可惜的是,在接了两次这家培训机构的广告之后,它就倒闭了。 + +之后,很长一段时间我都没有接到过广告。直到网易的课程合作找上门,一篇文章 1000 元,每个月接近一篇,发了接近两年,这也算是我在大学期间比较稳定的一份收入来源了。 + +![网易的课程合作](https://oss.javaguide.cn/about-the-author/college-life/image-20230408115720135.png) + +老粉应该大部分都是通过 JavaGuide 这个项目认识我的,这是我在大三开始准备秋招面试时创建的一个项目。没想到这个项目竟然火了一把,一度霸占了 Github 榜单。可能当时国内这类开源文档教程类项目太少了,所以这个项目受欢迎程度非常高。 + +![JavaGuide Star 趋势](https://oss.javaguide.cn/about-the-author/college-life/image-20230408131849198.png) + +项目火了之后,有一个国内比较大的云服务公司找到我,说是要赞助 JavaGuide 这个项目。我既惊又喜,担心别人是骗子,反复确认合同之后,最终确定以每月 1000 元的费用在我的项目首页加上对方公司的 banner。 + +随着时间的推移,以及自己后来写了一些比较受欢迎、比较受众的文章,我的博客知名度也有所提升,通过写博客的收入也增加了不少。 + +### 增加个人影响力 + +写技术博客是一种展示自己技术水平和经验的方式,能够让更多的人了解你的专业领域知识和技能。持续分享优质的技术文章,一定能够在技术领域增加个人影响力,这一点是毋庸置疑的。 + +有了个人影响力之后,不论是对你后面找工作,还是搞付费知识分享或者出书,都非常有帮助。 + +拿我自己来说,已经很多知名出版社的编辑找过我,协商出一本的书的事情。这种机会应该也是很多人梦寐以求的。不过,我都一一拒绝了,因为觉得自己远远没有达到能够写书的水平。 + +![电子工业出版社编辑邀约出书](https://oss.javaguide.cn/about-the-author/college-life/image-20230408121132211.png) + +其实不出书最主要的原因还是自己嫌麻烦,整个流程的事情太多了。我自己又是比较佛系随性的人,平时也不想把时间都留给工作。 + +## 怎样才能坚持写技术博客? + +**不可否认,人都是有懒性的,这是人的本性。我们需要一个目标/动力来 Push 一下自己。** + +就技术写作而言,你的目标可以以技术文章的数量为标准,比如: + +- 一年写多少篇技术文章。我个人觉得一年的范围还是太长了,不太容易定一个比较合适的目标。 +- 每月输出一篇高质量的技术文章。这个相对容易实现一些,每月一篇,一年也有十二篇了,也很不错了。 + +不过,以技术文章的数量为目标有点功利化,文章的质量同样很重要。一篇高质量的技术文可能需要花费一周甚至半个月的业余时间才能写完。一定要避免自己刻意追求数量,而忽略质量,迷失技术写作的本心。 + +我个人给自己定的目标是:**每个月至少写一篇原创技术文章或者认真修改完善过去写的三篇技术文章** (像开源项目推荐、开源项目学习、个人经验分享、面经分享等等类型的文章不会被记入)。 + +我的目标对我来说比较容易完成,因此不会出现为了完成目标而应付任务的情况。在我状态比较好,工作也不是很忙的时候,还会经常超额完成任务。下图是我今年 3 月份完成的任务(任务管理工具:Microsoft To-Do)。除了 gossip 协议是去年写的之外,其他都是 3 月份完成的。 + +![](https://oss.javaguide.cn/about-the-author/college-life/image-20230404181033089.png) + +如果觉得以文章数量为标准过于功利的话,也可以比较随性地按照自己的节奏来写作。不过,一般这种情况下,你很可能过段时间就忘了还有这件事,开始慢慢抵触写博客。 + +写完一篇技术文章之后,我们不光要同步到自己的博客,还要分发到国内一些常见的技术社区比如博客园、掘金。**分发到其他平台的原因是获得关注进而收获正向反馈(动力来源之一)与建议,这是技术写作能坚持下去的非常重要的一步,一定要重视!!!** + +说实话,当你写完一篇自认为还不错的文章的幸福感和成就感还是有的。**但是,让自己去做这件事情还是比较痛苦的。** 就好比你让自己出去玩很简单,为了达到这个目的,你可以有各种借口。但是,想要自己老老实实学习,还是需要某个外力来督促自己的。 + +## 写哪些方向的博客比较好? + +通常来说,写下面这些方向的博客会比较好: + +1. **详细讲解某个知识点** :一定要有自己的思考而不是东拼西凑。不仅要介绍知识点的基本概念和原理,还需要适当结合实际案例和应用场景进行举例说明。 +2. **问题排查/性能优化经历** :需要详细描述清楚具体的场景以及解决办法。一定要有足够的细节描述,包括出现问题的具体场景、问题的根本原因、解决问题的思路和具体步骤等等。同时,要注重实践性和可操作性,帮助读者更好地学习理解。 +3. **源码阅读记录** :从一个功能点出发描述其底层源码实现,谈谈你从源码中学到了什么。 + +最重要的是一定要重视 Markdown 规范,不然内容再好也会显得不专业。 + +Markdown 规范请参考:**https://javaguide.cn/javaguide/contribution-guideline.html** (很重要,尽量按照规范来,对你工作中写文档会非常有帮助) + +## 有没有什么写作技巧分享? + +### 句子不要过长 + +句子不要过长,尽量使用短句(但也不要太短),这样读者更容易阅读和理解。 + +### 尽量让文章更加生动有趣 + +尽量让文章更加生动有趣,比如你可以适当举一些形象的例子、用一些有趣的段子、歇后语或者网络热词。 + +不过,这个也主要看你的文章风格。 + +### 使用简单明了的语言 + +避免使用阅读者可能无法理解的行话或复杂语言。 + +注重清晰度和说服力,保持简单。简单的写作是有说服力的,一个五句话的好论点会比一百句话的精彩论点更能打动人。为什么格言、箴言这类文字容易让人接受,与简洁、直白也有些关系。 + +### 使用视觉效果 + +图表、图像等视觉效果可以让朴素的文本内容更容易理解。记得在适当的地方使用视觉效果来增强你的文章的表现力。 + +![](https://oss.javaguide.cn/about-the-author/college-life/image-20230404192458759.png) + +### 技术文章配图色彩要鲜明 + +下面是同样内容的两张图,都是通过 drawio 画的,小伙伴们更喜欢哪一张呢? + +我相信大部分小伙伴都会选择后面一个色彩更鲜明的! + +色彩的调整不过花费了我不到 30s 的时间,带来的阅读体验的上升却是非常之大! + +![](https://oss.javaguide.cn/2021-1/image-20210104182517226.png) + +### 确定你的读者 + +写作之前,思考一下你的文章的主要受众全体是谁。受众群体确定之后,你可以根据受众的需求和理解水平调整你的写作风格和内容难易程度。 + +### 审查和修改 + +在发表之前一定要审查和修改你的文章。这将帮助你发现错误、澄清任何令人困惑的信息并提高文档的整体质量。 + +**好文是改出来的,切记!!!** + +## 总结 + +总的来说,写技术博客是一件利己利彼的事情。你可能会从中收获到很多东西,你写的东西也可能对别人也有很大的帮助。但是,写技术博客还是比较耗费自己时间的,你需要和工作以及生活做好权衡。 \ No newline at end of file diff --git a/docs/readme.md b/docs/readme.md index 28ef4ad4..e1aef79f 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -37,6 +37,7 @@ footer: |- - [我曾经也是网瘾少年](./about-the-author/internet-addiction-teenager.md) - [害,毕业三年了!](./about-the-author/my-college-life.md) - [我的知识星球快 3 岁了!](./about-the-author/zhishixingqiu-two-years.md) +- [坚持写技术博客六年了](./about-the-author/writing-technology-blog-six-years.md) ## PDF