# 工程師：「我只想好好寫 Code，不想寫技術文件」

- 作者：林鼎淵（Dean Lin）
- 網址：https://deanlin.net/blog/202208/engineers-and-technical-docs/
- 發布：2022-08-17
- 主題：團隊合作
- 標籤：科技島專欄、技術文件、職涯
- 摘要：我們為了完成功能已經竭盡心力，實在沒有多餘的體力去寫技術文件；因此有些人在交付功能給同事時，文件在有與沒有之間，有時甚至直接用口述、Demo 代替。

這個標題應該是很多工程師的心聲。

我們為了完成功能已經竭盡心力，實在沒有多餘的體力去寫技術文件；**因此有些人在交付功能給同事時，文件在有與沒有之間，有時甚至直接用口述、Demo 代替**。

這種情況在一個人獨立作業的專案更為常見，因為他覺得這份專案就只有自己一個人維護，技術文件是要寫給誰看？

身為工程師，我也曾有過這些想法；但隨著經手的專案越來越多，我深刻理解到「技術文件」是一個無法逃避的任務。

## 沒寫技術文件會發生什麼事？

下面列出幾點常見的問題：

1. 專案的核心工程師離職後，如果沒人了解這個專案過去的歷史，那就只能等它自行炸裂。
2. 就算離職前有做交接，相信我，一定會漏東漏西，不要相信人類的記憶力。
3. 就算是獨自開發的專案，往往一年後需要維護、擴充時，你會懷疑自己有失憶症。

了解沒寫技術文件會埋下的未爆彈後，就算不為接手的工程師考慮，也為將來的自己寫一下吧！

## 為什麼會沒人撰寫、維護技術文件？

大部分是公司文化的問題。

最常見的原因是「專案時程太趕」，功能都快要做不完了，誰還有時間寫文件？如果產品能夠順利交付，更不會有人在事後把文件補齊。

另一個因素是「大家不知道文件該怎麼寫」，除非有前人的範例可以參考，不然每個人認定文件該有的內容都是不一樣的。

> 過去筆者有寫一篇部落格，[分享 README.md 對專案的重要性](https://medium.com/dean-lin/c0fb0908343e)，有興趣的朋友可以參考看看。

## 想跟大家聊聊

平常大家有寫技術文件的習慣嗎？

規劃任務時，有把撰寫文件的時間考慮進去嗎？又或是額外開一張寫文件的 Ticket 呢？

過去在工作上，有因爲缺少技術文件而發生的悲劇嗎？歡迎大家在留言區分享自己的血淚史喔！

---

關於作者：林鼎淵（Dean Lin），台灣的生成式 AI 企業內訓講師、外商資安公司軟體專家，也是生成式 AI 創新學院發起人。出版 7 本書（包含全台第一本 ChatGPT 應用專書），兩度獲得 iThome 鐵人賽佳作，累積上百場授課與顧問經驗。（https://deanlin.net/about/）
引用時請附上原文網址：https://deanlin.net/blog/202208/engineers-and-technical-docs/