【教學】寫作六步驟 讓工程師撰寫流暢的技術部落格

近年來,不管是菜鳥還是資深開發者都流行寫技術部落格,分享自己的學習足跡。為了幫助學生擺脫被動學習的習慣、讓自己的所學更加紮實,ALPHA Camp 在全端網路開發實戰營開課前,就開始鼓勵學生撰寫部落格。

對開發者而言,寫技術部落格好處多多,對學習、求職、建立個人品牌都有正面助益。我們的學生們也寫出了心得,享受邊學邊寫、邊寫邊學的樂趣。

但對於許多自學程式的學習者心中,寫技術部落格如同苦差事,他們心裡想著:

學程式已經很辛苦了,還要花時間寫部落格?
從高中畢業後就再也沒寫過作文了,不知道怎麼寫出一篇通順的文章。
我還在學習中,給大家看到我的文章會不會讓人覺得班門弄斧?如果被發現有錯誤不就很丟臉?
我寫的這是什麼東西...

這些心理障礙都很正常。因此,我們將在本文分享如何破除心理障礙、並詳細說明「寫部落格的六步驟」,只要跟著做,將能顯著減少寫部落格時遇到卡住、離題、鬼打牆,建立信心和成就感。



寫技術部落格的好處

讓學習更紮實

心理學研究顯示:「最有效的學習方式,就是教別人。」自己將知識消化、吸收,然後教導其他人,學習成效更勝於考試。寫部落格就如同教學,需要有完整的邏輯和論述,一方面讓別人能夠看得懂,另一方面讓自己的學習更加紮實、更有成就感。

寫部落格是一個從被動學習轉為主動學習的過程。寫作的過程中,需要搜尋資料、找出重點、消化統整資訊,除了幫助自己建立深刻記憶,也可以大幅減少將來需要時,花在複習、喚起記憶的時間。

剛開始寫部落格,不用要求每一篇都要有獨特的個人見解,可以從最簡單的「筆記」形式開始,以自己剛學到的內容為出發點,在網路上多找一些補充資料,把一些概念的定義與關鍵字整理出來。光是這個動作,就能加深你對這些概念的印象。慢慢的,你就會能夠有效的分享你的學習過程與領悟,並把概念內化,說明給你的讀者。

 

提升軟實力


寫作除了為自己寫之外,當然也是希望與世界溝通。寫作的過程中,你需要把一些相對抽象、技術性高的概念,用他人可以聽得懂的語言,寫成有條理的文章。這個過程能幫助你鍛鍊出溝通表達能力。網路開發是一個很講究團隊合作的專業。良好的溝通表達能力是你提升為更優秀的開發者的重要一環。



有助於求職


尤其對於非資工背景的開發者而言,寫部落格可以幫助雇主們瞭解「你懂什麼」與「你能溝通嗎?」這兩個核心的技能。雇主除了看你的作品和面試表現,他們能經由你的部落格,看見你學了哪些技能、你是如何思考的、以及你的溝通能力。

相較於在自傳裡寫自己多積極、多有學習熱忱,不如一篇篇紮實的技術部落格,更能展現你的成長潛力。

 

幫助他人、發揮影響力


用心寫的內容,一定會被需要的讀者看見,你的部落格也將會持續幫助其他的開發者、學生,偶爾有大神路過也會指點一二。

持續提供價值的開發者是受到社群歡迎的,而部落格就是你提供貢獻的媒介,其他的例如個人品牌、工作邀約、拓展人脈等,都是隨之而來的附加價值。

寫部落格有那麼多好處,但很多人還是無法踏出第一步,或是好不容易開始了卻又三分鐘熱度。以下說明如何破除心魔:

 

寫部落格前 先破除你的心魔

我還那麼菜,要寫什麼?


寫部落格不是「大神」的專利。正因為你不是大神,所以你可以用凡人的角度、用凡人聽得懂的語言,分享你的知識和心得。身為開發者,每天都會有機會學到新東西。無論是菜鳥還是老手,剛學到新技能時記憶猶新,最適合記錄下來,幫自己複習,也分享給其他人。

 

我的文筆不好


技術部落格的重點不是文采,而是要清楚地表達你的觀念和想法。而所謂文筆不好更深層的原因在於:觀念不清楚和邏輯不通達。

觀念不清楚可以靠大量閱讀、多寫程式磨練,邏輯不通達則需要多讀、多寫,練習如何整理自己的思緒,改善溝通表達技巧。但重點是:不開始寫,文筆永遠不會變好。只要一開始寫,你就有進步的機會,也會逐漸寫出心得和興趣。

 

我沒有時間


有兩個原因造成「沒時間」寫部落格:缺乏動機以及時間管理問題。以下三個方法擺脫藉口:

  • 給自己設定合理的目標,例如目標每兩週寫一篇、長短不拘
  • 養成規律習慣,防止「拖延症」上身。例如固定安排每週日早上 4 小時專心寫作
  • 把寫作培養成習慣和興趣,而非被逼著寫、或是為了利益而寫

我不知道如何開始


好不容易下定決心,坐在電腦前卻文思枯竭、難以下筆,才發現自己的「手感」已經生鏽了嗎?手感生鏽沒關係,給它上油就行了。剛開始寫部落格時不要太貪心,可以從短篇的的學習筆記開始建立信心。

接下來,我們將分享「寫作的六步驟」,幫助你成功找回手感,順暢地完成第一篇文章。

 

開始動手寫!


以下是撰寫一篇技術部落格的流程。無論你要寫長篇、完整的文章,還是短篇的小筆記,這個流程可以幫助你聚焦,寫出一篇邏輯通順的文章。


一、選擇題材技術部落格的題材,大致上可分為以下七個類別:


技術部落格的題材,大致上可分為以下七個類別:

  • 介紹自己的作品
  • 適合在學習過程中地記下自己容易混淆的觀念。以解釋觀念為主,程式碼為舉例和輔助說明,實作的部分較少。
  • 實作教學的目的,是詳細紀錄做出一個功能的過程,文中會詳盡地說明技術觀念、操作步驟並附上程式碼,讓讀者可以跟著做。
  • 演算法解題分享(LeetCode 1. Two Sum)分享自己喜歡的的連結和學習資源。
  • 閱讀心得、參加活動和演講的心得


 


剛開始寫部落格,可以從簡短的「觀念筆記」和「資源分享」開始,為自己的手感暖身。建立起信心後,撰寫長篇的「實作教學」會更加有把握。

部落格的題材除了從自己學程式的過程出發,也可以瀏覽 Quora、Stack Overflow 等問答區,從他人的提問中找靈感。

 

二、蒐集資料、腦力激盪


選定要寫的主題之後,就可以開始蒐集資料。可以從自己正在學的主題出發,向外延伸找補充資料,Quora、Stack Overflow、技術部落格、和其他開發者請益,甚至 GitHub 上的技術文件都是你可以參考的對象。

要注意的是,在這個階段,你蒐集資料的目的只是「腦力激盪」、並幫助你列出文章大綱,而不是要寫出完整的文章。因此,一開始不要找一大堆資料、開一堆視窗,讓自己的思緒混亂又挫折,反而迷失方向。

以撰寫本文為例,一開始只看了五篇文章,雖然不多,但足以列出文章大綱。一邊讀參考資料的過程中,也一邊簡單紀錄自己可以用的重點,例如:為什麼要寫部落格、如何堅持下去、寫部落格會遇到的心理障礙...。過程中如果想到其他 ideas,也一起記下來。

 

三、列出段落大綱


就像畫圖前要先構圖,寫文章前先列出段落大綱,可以幫助你整理這篇文章的脈絡、檢視邏輯是否通順。大綱規劃得越清楚,就不會寫到一半時才發現自己在鬼打牆。

寫段落大綱不難,只需要把剛剛找資料時紀錄的重點,以自己的邏輯排序,並刪除不必要的部分。一開始的段落大綱不用很詳細,只需用簡短的句子和關鍵字,幫助自己整理這篇文章的架構。如下圖:



如上圖所示,把這篇文章分成三大段落,分別是「為什麼要寫部落格」、「寫部落格前要破除的心魔」、「寫部落格的步驟」,每個大段落中再用簡單的關鍵字,紀錄該段落會包含的內容。
擬定了文章的大概架構後,接下來開始做更細部的規劃。以上圖的第三段落「寫部落格的步驟」為例,我們來規劃更細部的大綱。如下圖所示:

 

注意到了嗎?原本的大綱只有「題材」、「找資料」等簡短的關鍵字,現在我們加入了更多詳細的論點,讓這個段落的輪廓更加清晰。

規劃段落大綱要到多詳細?這沒有一定的答案,以自己方便為主。但可以肯定的是,規劃得越清楚,之後寫文章一定會越輕鬆。段落大綱就是給自己的備忘錄,規劃大綱的過程中可以同時搜尋資料,把外部資料連結放在某段落的下面,讓自己寫到那個段落時不用再重新查一遍,節省時間。

 

四、撰寫文章段落


擬定大綱後,接下來開始撰寫文章段落。大原則是:最有把握的內容先寫、文章開頭與結尾可以最後寫。

先寫最有把握的段落,就像是為你的手感做暖身,幫助自己進入狀況。沒有把握的段落可以先放著,待搜尋更多資料後再來處理。

寫技術部落格時,寫到一半會卡住通常就兩個原因:一、觀念不清楚;二、不知道要寫什麼。如果觀念不清楚,就針對自己混淆的地方,閱讀更多資料找出答案。如果不知道要寫什麼,就回過頭將段落大綱規劃得更詳細,重新調整文章邏輯。

為什麼文章的開頭建議最後寫?因為當你對這篇文章的輪廓還很模糊時,撰寫開頭會很辛苦。等到文章完成了八九成,概念都融會貫通了,寫出精準、有力的開頭和結尾會非常順暢。

,幫助讀者再次複習,並邀請讀者留言提問和指教。

 

五、檢查、編輯


終於寫完了!但請注意,這時你完成的還只是「草稿」,先別急著發佈出去。

如同寫程式,寫完文章一定要仔細檢查,檢查錯字、贅字、專有名詞大小寫,並把句子修得更通順。如果對自己的寫作能力沒那麼有把握,可以把草稿傳給同領域的朋友,確認他們也可以看得懂。

。文章發布在部落格上之後,記得再用電腦、手機檢查排版有沒有跑掉。很多時候,即使文章在電腦上的呈現很 ok,但在手機上看才發現段落太長,一大堆字擠在一起密密麻麻、或是 code 截圖中的字太小看不清楚,這時就要再回過頭調整。

 

六、分享出去


發佈之後,除了在自己的臉書分享,也可以分享在和文章主題相關的開發者社群中(例如:

想讓更多人點閱你的文章,除了把連結分享在社群網站上,也別忘了加上一小段文案,介紹這篇文章的重點,吸引對這個主題有興趣的讀者,並且有禮貌地懇請大家提供回饋。

以下推薦更多資深開發者的部落格文章,供大家觀摩:

瞭解了寫部落格的好處以及寫作秘訣,只剩下付諸行動囉!期待大家能早日體驗到邊學邊寫、邊寫邊學的樂趣。