- 技術寫作手冊
- ThoughtWorks中國
- 4字
- 2022-05-07 15:55:56
長期主義
李一鳴:《這幾年技術寫作的感悟》
從翻譯開始
大概在4年前,我開始技術寫作。當時在學習Shiro,順手翻譯了幾篇官方文檔。我覺得這幾篇文檔寫的很不錯,但是英文不好的同學閱讀起來會比較費勁。另外,翻譯的過程也比較費時。既然我已經翻譯過,為何不分享出來?于是便注冊了博客,發布了三篇Apache Shiro的官方文檔翻譯。
再次登錄博客,時間已是半年之后。發現其中一篇有7000多的閱讀量,這個閱讀量還是挺出乎我的意料。不過其他兩篇閱讀量只有幾百。為什么有一篇閱讀量這么高?當時的我沒想明白。很久之后才發現可能是因為這篇文章在百度檢索靠前的原因。在百度中搜索“Apache Shiro文檔”,可以看到三年前的這篇翻譯排在最前面。
7000多閱讀量也給了我寫作的信心,于是寫博客的念頭也就延續了下來。
開始原創
一年后,由于工作上需要使用Apache Kafka,于是花了些時間學習。后來在團隊內做了一次分享。在這個過程中,我閱讀了很多文檔和書籍,逐一消化成為自己的知識。如果把自己學習到的內容以系列文章的形式留存下來,不僅讓自己能夠學習的更深入、記憶的更牢固,而且也能夠幫助到初學者。其實之前我沒寫過技術博客,更沒寫過教程,沒有任何經驗。但我對于自己把一個問題說清楚的能力比較自信,另外也相信自己能堅持下來。于是一上來我就定位寫系列教程文章。
我對于文章的要求是通俗易懂。所以多采用生活中的例子以及繪制了大量的圖表用于文章中。徹底理解了的內容我才會寫上來,并且一定力求讀者能夠看明白。在之前學習過一遍的基礎上,大概又花了一個月的時間完成《Apache Kafka入門教程輕松學》系列8篇博客。
接下來我又完成了《ZooKeeper入門實戰教程》系列,一共5篇。后面寫了一些Apache pulsar的翻譯文章及其他一些零散的文章。
有何回響?
寫完博客當然希望有更多的人來看。但是如果一開始就報這個目的去寫,一定是急功近利。為了點擊量有一萬種寫法。為了博客的關注量,也可以有一萬種寫法和做法。但這對文章質量可能毫無幫助。其實投機取巧的方法有很多,不過我不想走這種捷徑。
我最初的想法很簡單,踏踏實實寫一些對自己和讀者真正有幫助的文章。不浪費讀者的時間,也不浪費自己的時間。最開始就堅定以內容質量為核心價值來寫文章。
博客一開始自然沒有什么點擊量,不過也并不影響寫博客的心情。不過偶爾有人留言問問題或者給我鼓勵,我還是很欣慰。寫作目的不一樣,寫作的心情就不一樣,最終寫出來的內容也不會一樣。管那么多呢,先把心思花在文章質量上。
一次和同事聊天,他說那天我在百度搜索Pulsar,第一個結果就是你的博客。當時我很詫異,因為之前從沒有把我的博客和百度聯系起來。當時Pulsar確實屬于比較新的工具,文章比較少。我也只是隨便寫了一篇介紹文章而已,毫無質量可言。但是這篇文章的訪問量卻比用心寫的那些博客高的多,也不知道該高興還是難過。不過通過這個事情,我了解到百度的力量。怪不得那么多公司不惜重金在百度上做SEM或者SEO。
當時我覺得這只是因為Pulsar比較新,我鉆了個空子被百度排在了前面。因為文章本身沒什么價值。所以其實并沒有給我帶來什么成就感。
有段時間我換了新的工作后,工作比較忙,沒時間繼續寫博客。后來又有段時間去別的平臺寫專欄。但這段時間博客的關注量、評論量、點贊量一直是上升的趨勢。因為有之前Pulsar的事情,我想到是不是有哪篇文章在百度排到前面去了。于是去百度搜索了下,發現按照技術名稱+教程或者+標題中關鍵字檢索,我的一些博客排在了前面,比如按照“apache kafka概念”、“apache kafka教程”、“apache kafka入門”、“zookeeper教程”、“zookeeper入門”等相似關鍵詞搜索,我的博客都能排在前三名。
這次和Pulsar文章排在前面比較起來,感覺是不一樣的。因為這些文章確實是我花費心思去創作的。自己的文章能被更多人看到,能幫助到更多初學者,還是很有成就感。最重要的是堅定了繼續寫下去的信心和動力。
一些感想
我開始技術寫作到現在已經四年多,時間不算太長,不過也有些個人有些感悟。隨便說一說。
寫作目的
首先想說的是寫作的目的。寫博客沒有利,說俗點就是賺不到錢。那么寫博客會出名嗎?不排除有些大牛會通過博客出名。但是對于絕大多數寫博客的人來說是不會出名的。讀者看到你的文章能解決他的問題,并且心情好時,可能會給你點個贊。但誰也不知道你是誰,而且技術博客這么少的閱讀量也不足以讓你出名。但是技術博客是一個窗口,能讓更多人能看到你、了解你。如果你的文章質量足夠好,當然也會有更多的機會找上門,比如說寫專欄、甚至出書。不過這些畢竟是少數,剛開始技術寫作的朋友還是應該腳踏實地,寫好每一篇文章,并且堅持下來。
從我個人而言,我寫博客出于以下幾個目的:
鞏固學過的知識
分享知識,幫助更多同行
成就感
最開始我只是想通過文章鞏固自己所學知識。學習是輸入的過程,寫文章是一個輸出的過程。如果能在工作中實踐當然是最好的輸出,但并不是學習的內容都有實踐的機會。那么寫文章輸出也是個不錯的選擇。
如果寫文章只是為了鞏固知識自己看,那么文章的質量就沒那么重要,自己看懂就好了。當你的文章將要對外發布,需要考慮的因素就會更多。比如是不是通俗易懂,有沒有模糊的知識點、有沒有錯誤、語句是否通順等。
如果想讓更多的人看到你的文章,文章的質量就變得尤其重要。技術領域一切都以質量說話,時間沉淀下來的肯定是有質量的文章。比如我之前在百度排在前面的Pulsar的文章現如今已經在幾頁開外了。
成就感對于我來說是個副產品,是隨著你的寫作而來的。但是很重要,因為這是正向的反饋。有人在讀,說明你寫的還可以,并且確實也幫助到了一些讀者。那么繼續寫下去才有更大價值。
在這個自媒體泛濫的時代,好多文章選擇標題黨或者走其他走捷徑的方式。但在技術領域行不通。不要一開始就沖著文章的點擊量去寫文章。其實你只需要搞定一件事,那就是文章的質量。其他都是隨之而來的。當然好的標題也很重要,不過再好的標題也要有同等質量的文章相匹配。
長期主義和積累
寫博客是個積累的過程,從你的第一篇博客開始,到10篇、100篇,以至更多。這絕對是一個長期的過程。當然也有辦法讓你的博客一天就刷到100篇,比如轉載。但是這樣做沒有價值和意義。我也不清楚我的博客在百度中排到前面用了多久,但我相信肯定不是三個月就能做到的。
文章開始沒有點擊量很正常,不用氣餒。至少從我的經驗來看,只要文章寫的不錯,終歸會被讀者認可。
還記得最初寫了幾篇博客后,沒有人關注,閱讀量也很低,難免心里會有些失落。但是隨著你積累的文章越來越多,你會發現各種數據都會加速上漲。因為寫文章是一次付出,持續收獲。每一篇文章都是你的存款。即使有段時間你不寫博客,還是會新增很多關注、點贊。當然,寫作是一種習慣,需要堅持,最好不要中斷。
寫博客的快樂和痛苦
寫博客很快樂,否則也不會寫下去。學到知識的快樂、分享的快樂、被認可的快樂。然而痛苦也會很多,要寫出一篇質量比較好的博客,需要付出很多。首先自己要徹底搞懂要寫的技術,然后再用自己的語言通俗易懂的寫出來,還要自己繪制圖表。這個過程需要付出很多時間和精力。
以我的經驗,一篇2000-3000字的博客至少需要4個小時左右(學和寫)。要求更高的專欄文章,起碼要6個小時。只是寫寫博客還好,畢竟沒有交稿的壓力。如果和平臺合作寫專欄,面對交稿的時間點,會給你巨大的壓力。我曾經寫了半年專欄,業余時間除了寫就是寫。每晚幾乎都是1點以后睡。周末要帶小孩,于是抓各種空子寫。小說、電影、電視劇基本和我告別了。
有人認可你的文章,自然也會有人認為你的文章是垃圾。不要因為個別負面聲音影響自己的信心。自己的文章當然也會有錯誤。讀者指出來,最初會覺得有點沒面子。是人就會犯錯嘛,既然放到互聯網上,就不要怕犯錯。其實讀者也是在幫助你糾正錯誤的知識點,是個好事情。
說了這么多寫作的痛苦,但寫博客的好處會更多。比如下面這些:
能力鍛煉
寫博客是吸收知識、消化知識、再次形成知識的過程。在這個過程中,你的學習能力、總結能力、表述能力都能得到提升。
鞏固學習的知識
博客也可以認為是你的學習筆記。通過寫博客可以鞏固學習到的知識。在你工作中或者面試前,可以用博客來復習。
個人能力背書
短短幾十分鐘的面試,根本無法讓面試官對你有全面的認知。如果你的簡歷中有博客地址,面試者可以通過閱讀你的博客,對你有更全面的認知。這是我在面試過程中的切身感受,很多面試官都會去看你的博客。
此外,博客也是你對外展示的窗口,更多的人可以通過博客認識你。通過寫博客,我才有了和專欄平臺合作的機會。這是我最初寫博客沒有想到的。最初專欄平臺通過博客找到我寫專欄,我還有些猶豫,不知道自己能不能寫出來并堅持下去。后來想給自己一個挑戰,于是就把這個事情接下來了。過程是相當痛苦的,這里就不再詳述,不過總歸是完成了專欄。寫專欄的過程對我后來工作上碰到的一些困難還是很有幫助——只要有信心,朝著正確的方向堅持前進,那么一定會勝利抵達終點。
最后
這幾年寫技術博客的快樂肯定大于痛苦。而且之前所謂的痛苦,現在看來也不算什么。以后肯定還會堅持寫下去。學習是長期的事情。學習之余,把學到的知識總結成博客,對自己有益,又能幫助到其他有需要的人,哪怕只是一小部分,那又何妨?學無止境,筆不停耕。