為什麼寫文件?
基於以下原因,我覺得公司內部的文件,有其必要性:
- 人的記憶力不可靠,不管是什麼人、什麼角色、性別、智商、年齡。
- 人常常會忘記為什麼做那些事情、為什麼要那樣做。
- 文件的讀者第一個一定是自己,自己都不看,自己都看不懂,是要誰來看?
寫文件的目的
- 減少 溝通成本
- 讓接手的人能夠清楚知道到底做了些什麼
- 文件要預設閱讀的對象以及角色
- 沒人會看的文件不要寫
- 如果寫不出來,或者文章結構不清楚,表示自己不夠瞭解該主題
- 文件要記錄必要的『理由』,像是為什麼要做這功能?
- 有些原因背後的理由像粽子串一樣深,如果不記錄下來這些原因的關聯性,很容易被打槍。
- 把知道的東西結構化,像寫程式一樣重構
寫文件的技巧
- 設定閱讀對象
- 清楚的大綱結構 (Table of Content, ToC)
- 精準的用詞
- 標記引用來源
- 圖表化
- 連結
寫文件最大的挑戰
- 很多人的閱讀能力不好 (我也是常常眼銼看錯),所以一定要花時間
go through
- 沒有閱讀的習慣:特別是很複雜的描述。
- 如何言簡意賅
主動賓
不清楚:這是中文的問題與習慣,因為中文表達很常會下意識地省略『主詞』、『受詞』,所以很容易讓讀的人誤解。- 不清楚閱讀對象的背景 (Baseline)
工作進度、狀況管理
- Slack 現在是中斷思緒、降低工作效率的來源
- 對話完全無法組織整理,隨著時間前進,無法累積團隊的知識,變成企業的 KM。
- 他終究只是個 IM,更別說用啥
pin
可以取代 Issue Tracking or Email。 - Slack 的 Search 功能也很蠢,明明就打開一個 “Direct Message”,點了 Search 還是找到全部的 ….
- 所以還是要有專案管理工具做 Queue 的角色,然後要花時間 Review, Re-org, Classify 那些 “Issues”。
- 不管用哪一套 Issue Tracking System,這件事情還是要有人做。
- 不要期望有啥 ML or AI 可以幫忙整理這些,也不要把這件事情丟給底下的人做。
- 如果 ML 可以做到這件事情,那麼可以賺錢的 Business Model 很快就會被找出來,然後,很多新創公司很快就收起來了。
- 因為商業上的知識,是靠不斷的組織與淬鍊,才能累積出來的。
- AI/ML 可以做到這樣,也是人類的末日了。
Reader is Leader
西方人說:「Leader is reader.」(領導者一定是閱讀者)
如果管理階層本身就不是 Reader,在他管理之下的公司,通常不會有多大成長。
延伸閱讀
站內延伸
學習、寫作、閱讀系列文章
- 學習法則
- 一個人的 Working Backwards
- 閱讀能力的重要性
- 為什麼寫文件?
- 再談『為什麼寫文件?』
- 分類的哲學
- Spotlight 現象
- 文件的持續交付
- 寫文件常見的問題
- 從 Jeff Bezos 與 Werner Vogels 學到的
- 導讀持續交付 2.0 - 談當代軟體交付之虛實融合
- 有效定義目標與執行、落地