Refactoring English - Effective Writing for Software Developers 一個篇章的讀後心得

偶然間在網路上看到這本書《Refactoring English - Effective Writing for Software Developers》， 作者是 Michael Lynch。 而這本書今年 (2025) 才開始在撰寫，目前只有一個篇章 Rules for Writing Software Tutorials。 但已深深吸引了我，給了我不少啟發。

想法改觀

這篇文章讓我重新思考了撰寫教學文章的方式，尤其是在目標讀者與讀者實際能獲取知識部分。

或許會跟原作者想法有些出入，但這是我受到這篇文章所獲得的啟發有以下 3 點：

1. 明確讀者群體

用讀者的視角撰寫

大多數讀者是特定領域的初學者。這提醒我，撰寫文章時應避免使用過多的術語，並以讀者的視角進行解釋。 過去我往往忽略了這一點，這更加深我對於文章撰寫，要先了解使用者的重要性。

2. 成果導向的標題

讓標題直接說明讀者的收穫

標題應該明確地告訴讀者學習後的具體收穫，而非使用模糊的詞彙。 例如，以前可能會使用「GitHub Trending」的標題，但現在更傾向於具體的描述，如「如何開啟 GitHub Trending 頁面，找到 GitHub 上最熱門的專案」。

3. 展示最終結果與提供可執行程式碼

可視化成果與程式碼執行

這篇文章強調了讓讀者一目了然地看到最終成果的重要性。這一點讓我重新審視自己以往的內容，尤其是程式碼部分，我應該更清晰地標示哪些部分需要修改，並確保提供的程式碼能直接執行。

---

滿推薦大家，可以看看這篇文章，或是關注作者的後續文章。我也很期待這本書的完成。

那麼，你對技術教學的撰寫有什麼想法呢？歡迎留言與我交流！