本文適用於程式開發人員 (PG)，不討論系統設計或分析師 (SA, SD) 需要撰寫規格書的狀況。

• 寫文件的好處 - 只寫程式不寫技術文件，那就通靈吧！- 軟工現場觀察 Devin Deving

為什麼要寫文件呢？可歸納為以下幾點：

1. 對於剛入門的新手來說，文件有助於更快速地進入狀況。
2. 複習自己曾經碰過的東西，減少重新嘗試的成本。
3. 整理自己的想法，協助釐清複雜的問題。
4. 與口耳相傳比，可避免遺漏掉重要的資訊。

如果不知道要寫哪些文件，可以先從以下的狀況開始記錄：

1. 奇怪的商業邏輯，無法很快看出邏輯、流程的程式碼。
2. 組態設定檔，以後在新電腦上可以快速快速還原組態。
3. 特殊的程式寫法，例如用奇怪的方式繞過 Bug。

• 請問要怎麼寫說明文件呢?? - iT 邦幫忙

寫文件不一定有硬性的規定，能讓讀者快速理解是最重要的。

1. 使用者操作文件：最好可以附圖解。
2. API 的操作說明：通常可以由程式自動產生 (ex. Swagger)
3. 專案架構與程式清單。

(原文發表於個人 Github Pages)

附錄

• 值得一讀的鐵人賽系列文章：[IT上櫃心法]-9.系統文件 - iT 邦幫忙
• 敏捷開發也需要文件，測試也視為文件的一種：Agile Documentation 敏捷開發需要哪些文件? – Ruddy Lee 分享空間
• 用 MarkDown 畫流程圖: Week28 - 讓你心裡的邏輯具現化的念能力工具 Mermaid [Server的終局之戰系列] - iT 邦幫忙

鐵人賽結語

這次鐵人賽沒有順利每天發文，有點可惜，但最後還是用個人 Github Pages 的文章改寫並發完 30 天了。
希望明年還有機會，提供大家更多的知識。

謝謝大家的閱讀。