再談『為什麼寫文件?』


寫文件,對很多人是很痛苦的事情,特別是工程師。不過,我卻一直很享受這件事情,享受重新組織整理知識的過程,因為這個過程獲得最多的是我自己。


聊聊關於文件

底下這段文字,是我 自言自語 的紀錄,表達了個人對於組織內寫文件的看法。

很多人會跟我說:寫文件不重要,寫了也沒人看,寫文件花時間。。。balabala …..

恩,我只有幾個問題反問:

  1. 你會看自己寫的 文件?如果你自己都不看,那內部文件不寫也罷。
  2. 你看完自己寫的 文件,看得懂嗎?會更正嗎?如果不會那砍掉好了,也不用寫了。
  3. 你寫 Blog 嗎?你自己會看嗎?如果你自己都不看那就不要寫。
  4. 你讀書嗎?如果你不讀書,那也不用寫文件。

請用 code文件, 道理一樣

有寫,就有讀,有讀,就有寫。文件是用來傳遞經驗與知識的。前面的四點都做不到,傳遞的就沒啥意義。

時間問題:好的文件,例如 OSS (Open Source Software) 的 README.md 通常自己看就知道怎麼做。比起在那邊慢慢問人,搞清楚到底要做啥,是更有效的方法。OSS 的資訊傳遞都是靠文件,從文件中就可以掌握大部分的資訊與知識。寫好的文件不重要?不需要花時間讀文件?如果組織裡沒有這樣好的文件,難道一個團隊一個個問?還是觀落陰算了?

所以我堅決要寫文件,因為人不可靠 (in-memory),落地 (persistence) 才可靠。但 寫文件 這件事要訓練,要修正,跟 code 一樣

很多人問我問題,我會很快地跟你說在我 Blog 的哪一篇,因為我每天都自己在讀,然後修正。另外一個因為我很重視 結構與分類 的問題,可以很快用關鍵字找最短路徑。有次同事寫的文件不知道放哪,我是十秒不到找到他寫的文件,因為我知道 分類結構

普遍的問題

企業內文件為什麼會被當作箭靶?很多人覺得這不重要,甚至大肆批評寫文件是浪費時間?

歸納原因應該有底下:

  1. 寫文件的人表達能力不佳
  2. 員工沒有閱讀習慣
  3. 文件沒有被有效的組織與管理
  4. 文件沒有被廣泛的傳遞與閱讀

基本上,理想的文件循環如下:

寫 -> 讀 -> 組織 -> 修正

這些循環缺一不可,但一般的企業的問題,都會以為買了一個工具(像是 Confluence) 文件就搞定了,這跟協作管理系統一樣,以為裝個 Redmine / JIRA / VSTS 就搞定了,但是本質的問題卻都沒有面對,或者沒認知到那才是問題的根源。


A Leader is a Reader

這句話很常見:領導者是閱讀者。

為什麼?因為他能廣泛地吸收各家的想法,透過文字的傳遞,了解別人的思緒。閱讀的過程本身就是一段思考的過程,閱讀是主動學習之一。而寫作則是傳達理念的方法之一,所以我覺得:

領導者是閱讀者,同時也會是寫作者。


延伸閱讀

學習、寫作、閱讀系列文章


Comments