寫文件,需要有邏輯、有結構,
記錄和整理的難度很高、曠日廢時外,更慘的是,寫了也沒人看、看也看不到重點 [1] [2] ...
雖然如此,但寫文件還是有其必要性,
例如公司相關規定、作業流程 (SOP) 等,都需要寫成文件來完整紀錄。
雖然「完整」是文件的一項特性,
但也不可能把所有細節都寫在一起,因為
- 內容太複雜
東西越多,主軸和結構的安排就越困難。
即使寫的時候思路可以很清晰,但事後 or 讀者要理解的難度也很高。
- 不同的經驗,記錄的方式不一樣
例如問題處理,就適合用 Q&A 的形式,直接對症下藥。
- 維護困難
如果只是改幾個小地方,要從長長的內容中找到並修改,難度比較高,也比較麻煩,久了就沒有動機處理。
要如何降低門檻,
讓辛苦寫的內容別人讀得懂,還可以讀到重點呢?
馬克吐溫說的有道理 ~
成功的秘訣,就是把複雜的事,拆成一件一件做得到的小事,然後從第一件做起。
簡單來說,
就是拆解後各個擊破 (divider and conquer)。
為此,xms+ 特別為不同的經驗,設計不同且簡潔的紀錄與呈現方式,並允許各自獨立撰寫。
參考資料:
- 已經有文件了,為什麼還要寫 FAQ? (含案例說明)
- 為什麼是寫 FAQ,而不是一般的文件?
- 文件不會寫怎麼辦?