本文介紹一些寫文件的入門觀念文章，並記錄重點與自己的想法。
為何要寫文件
- 對於剛入門的新手來說，文件有助於更快速地進入狀況。
- 複習自己曾經碰過的東西，減少重新嘗試的成本。
- 整理自己的想法，協助釐清複雜的問題。
- 與口耳相傳比，可避免遺漏掉重要的資訊。
應該要寫哪些文件：
- 奇怪的商業邏輯，無法很快看出邏輯、流程的程式碼。
- 組態設定檔，以後在新電腦上可以快速快速還原組態。
- 特殊的程式寫法，例如用奇怪的方式繞過 Bug。
如何寫文件
寫文件不一定有硬性的規定，能讓讀者快速理解是最重要的。 應該要寫哪些文件：
- 使用者操作文件：最好可以附圖解。
- API 的操作說明：通常可以由程式自動產生 (ex. Swagger)
- 專案架構與程式清單。
附錄
- 值得一讀的鐵人賽系列文章：[IT上櫃心法]-9.系統文件 - iT 邦幫忙
- 敏捷開發也需要文件，測試也視為文件的一種：Agile Documentation 敏捷開發需要哪些文件? – Ruddy Lee 分享空間
- 用 MarkDown 畫流程圖: Week28 - 讓你心裡的邏輯具現化的念能力工具 Mermaid [Server的終局之戰系列] - iT 邦幫忙