寫文件的好處

不知為何,絕大多數的工程師們都很討厭寫文件,雖然在我的職涯頭兩年,好像也的確沒碰過文件,但後來幸運地跟有撰寫文件習慣的團隊合作過之後,再跟沒文件習慣的團隊合作就意識到了文件的重要性,所以今天我想跟大家來分享我覺得寫文件有哪些好處。

一、白紙黑字,有憑有據

首先,我覺得有文件的第一個好處就是吵架開會的時候比較有依據。

沒有文件的時候大家口說無憑,甚至你自己說的話過了三、五天,甚至一、兩週之後,你不一定記得自己之前講了什麼,最慘的是客戶或是主管很容易就不小心施放了隕石術,把之前講過的東西都直接推翻。

而有文件之後,就比較可以避免這種情況,當然文件上面最好標註了當前的版本、日期,以及改動了什麼內容等,這樣比較可以大聲說話會沒有爭議。

更甚者還有改完文件後逼大家都看過、沒問題之後簽下大名的作法,以後就比較沒辦法耍賴了。

二、利於溝通

第二個好處我覺得是可以讓溝通更順暢、更有效率

在沒有文件之前很容易各說各話、容易發散,明明是同一件事情但上週可能用 A 詞彙,但這週用 B 詞彙,因此產生誤會,白白浪費許多的時間。

而有文件之後,大家在溝通時可能就可以用文件上的標題或是編號來溝通,節省時間又不容易誤會。

此外,有個文件的名稱就叫做「詞彙表(_Glossary_)」,用來記錄公司對內或對外的各種縮寫專有名詞。

三、便於傳承

第三個好處是我覺得最重要的好處-傳承

在沒有文件的時候,只要當時做專案或產品的那些人一旦都已經離職,該專案或產品一旦出了什麼問題,後續維護非常不便。

對工程師來說,該專案或產品的程式碼就會變成所謂的 Legacy code ,沒人知道當初為什麼程式碼要這樣寫,不知道如何下手或是這個改動會不會把其他功能改壞;對 Manager 來說,一旦老闆或客戶來詢問當時為什麼會這樣設計、需求為什麼這樣開的時候,也沒有人可以回答的出來,進而導致老闆或客戶的不信任。

還有另外一種狀況是當有新進同仁時,該同仁需要花一、兩個禮拜的時間去爬 code 、邊使用邊對照,甚至還要拉著老人問這個問那個之後才能夠對於該產品或專案有比較基礎的認知,勞民傷財

而有了文件之後,有新進同仁就把文件丟給他看,花個兩三天就可以讀完;舊專案需要維護,找一下文件就知道要怎麼改;而老闆或客戶有問題也能夠迅速的從文件中找到資訊回覆,皆大歡喜!

總結

寫文件有三大好處:

  1. 白紙黑字,有憑有據
  2. 利於溝通
  3. 便於傳承

基於上述這三大好處,我覺得寫文件是很必要的事情,一旦有了文件,做事情都高效了起來。

至於要怎麼寫文件、要寫什麼文件、誰要負責寫文件這些事情,我們下次再聊囉!

Your browser is out-of-date!

Update your browser to view this website correctly. Update my browser now

×