技術文章入門

陳小嬰
Parenting 數位研發
Feb 16, 2022

分享技術文章從何下手、怎麼收斂、寫到別人看得懂和一些經驗談

在開始寫之前,有幾點要注意:

  1. 建議使用固定平台,剛起步不要每個平台都寫一點,最後維護成本過高,就會荒廢你偉大的寫作事業。
  2. 不要害怕寫了沒人看,寫技術文章有一半是寫給自己看的。
  3. 不要因為怕寫錯所以不敢寫,為何是不敢寫,而不是盡力確保自己寫的資訊正確?身為工程師遇到困難就要想辦法克服呀!
  4. 別怕文筆不好別人看不懂,你不是在寫小說,只需要條理清晰即可。
  5. 就是沒有寫作熱誠和動力,寫超過100個字會要了命,好吧!你可以直接跳過這篇文章了。

開始寫技術文章

當你決定開始寫技術文章後,就要來決定題目,通常這個題目會是你想學的新技術,邊學邊紀錄,但畢竟學新技術時可能是從四面八方搜來的資訊,學習過程本來就複雜繁瑣,還要寫文章是要操死腦細胞嗎?當然不是!

我邊學邊寫的流程是這樣的:

跟上課寫筆記87%像!當然這種寫作技能也是透過練習培養的,也就是說寫久了就會進步,所以一開始可以一直練習寫草稿,直到你覺得可以把文章發出去為止。我的草稿就積了很多沒完成或只寫了標題的文章……

當你開始洋洋灑灑的寫下各種搜來的資訊、Code、相關連結後,可能會發現內容很發散,這要怎麼蛻變成一篇好文章呢?

文章架構

通常技術本身會有一個主架構,例如SDK架構、UI (前端)到 DB(後端)、環境建置到測試等等,依照主題、學習順序、搜到的資料來規劃架構,這時很有可能會發現,為了符合文章架構,還缺少很多資料和知識,這就是寫作增進學習的優點了。

當然如果挖得太深太廣,這篇文章很有可能永遠寫不完,所以捨棄跟標題不符的資訊,也是很重要的,例如標題是入門,那太深奧的就挪到下一篇文章吧!

通常我的架構就是從無到寫出Code的歷程:

從每個大標題去延伸次標題,想想自己或別人,依照這樣的順序學習,是否是快速有效的?

好了架構出來了,就是到處去搜集各種相關資料讓自己學會新的技術拉~

醞釀情緒

技術學會後,不知如何開始打出第一個字?寫作跟寫Code一樣,靈感來了手停不下來,真不知道要怎麼寫,可以給自己幾天的時間思考和放空,也許哪天就忽然有想法了。

但一開始總是要踏出舒適圈,強迫自己一點,寫作松是個挺好激勵自己的活動,透過時間壓力激發自己的潛力,時間久了就發現默默的就寫上癮了。

如何把技術文章寫好?

學習從模仿開始,多看看別人的技術文章,好的學、不好的引以為戒。

  1. 純文字或純圖表都不好閱讀,圖表我通常是用draw.io畫出簡單的示意圖。
  2. 技術文章最重要的還是Code,要自己run過確定正確,當然後來改版或環境不同造成的就不是你的問題了,只能盡量寫清楚。
  3. 大家都喜歡有一點幽默感和輕鬆愜意的語句,這不是必備,但我相信大部分工程師都滿有幽默感,也很會苦中作樂。
  4. 省字一哥一姊或太多廢話都會影響閱讀,重點還是在技術。
  5. 避免在文章上批評引戰,當這篇文章變成戰場,寫作事業中斷還好,要是壞了在業界的名聲那就不好了。
  6. 可以拿給同事、朋友、各種技術小夥伴看看,聽聽他們的回饋是進步的能量來源,當然被糾正了也不要氣餒,修正過後的你就會比昨天的你更好。

文章發佈之後的心態

寫完文章發出去,然後呢?每天像盯股票盯著看有沒有人閱讀嗎?剛開始可能會這樣,但如果你希望有多一點人看,可以發給同事朋友或技術社團,也許可以從中獲得些成就感,但技術文章的本質還是不變的。

寫下來的同時增進自己進步、把過程紀錄後分享給別人避免踩同樣的坑和降低學習成本。

這才是技術文章的本質而不是賺點閱率,所以很多人說技術文章是寫給自己看的,避免沒人看後得失心太重就不寫了。

最後,希望大家都能在寫技術文章的過程中成長和寫出成就感、培養興趣。:)

--

--

陳小嬰
Parenting 數位研發

喜愛動物又注重環保的iOS工程師就是我。Write the code change the world.