專案寫的差不多了，我們來聊聊一個很多工程刻意逃避或者忽略的東西：技術文件。
這裡說的技術文件，指的是描述程式碼設計和行為的文件。不是規格說明書或者使用流程的說明。
不寫技術文件，反正邏輯都在程式碼裡面，自己翻就有了。
測量單位是顯而易見的東西，比方說：我們是酒類的經銷商，我們記帳的系統，烈酒當然是以「瓶」，紅酒以「箱」，啤酒以「公升」為單位進行記帳，這麼明顯的東西不需要記錄下來吧。
可以想像看看，要是有一天來了新的工程師，他看到紅酒的資料裡面有 12.33 的銷售記錄，要花多長時間才會知道要怎麼解讀這筆資料？
假如你在為一個飛機定位系統撰寫文件。確保假設加入一條新的航線，程式碼至少要改 25 個地方以上。確定沒有文件記錄到如果要加入航線，到底要調整以及注意哪些地方的程式。
後面的維護者沒有看過你的每一行程式之前，完全沒有辦法更新任何商業流程。
iThome鐵人賽
看影片追技術