[工作心得]撰寫文件的原則

撰寫文件的原則

所有的管理作業都離不開文件的保留，因此凡事都會需要有文件保留， 都希望透過這樣的文件留存作業保留一直以來的努力產出的心血，可是在撰寫文件時常常會有一些問題的存在，而這些問題似乎一直以來都不被管理者注意到，甚至連撰寫者自己也都沒有發現，而真正發現問題的人都是新接手的人才發現問題，而此時此刻這樣的人可以做到甚麼，因該只有默默承受並設法改善吧！而這樣的做法其實都會有一些負面狀況出現，"前手給我這樣的資訊，為何我要給更完善的資訊給後手"，漸漸地就會呈現出文件是為留存而留存，呈現出交接文件無效化以及制式化的狀況出現。以下以技術文件為例來分享個人觀點。

一、撰寫時先入為主：

在進行文件撰寫時會依據某個特定任務進行撰寫，而此時撰寫時因為撰寫者本身就是開發者，因此會已經取得當時的時空背景與現實資料狀況去撰寫文件，導致出現一些先入為主的名詞出現，而這些名詞有多少人真的看得懂呢？畢竟真的會去看文件的人員，一般都是下一位接手的人在處理事務時去檢視，但這樣的情況就會有認知落差的問題出現。如資料擷取時，若使用的是"部門清單"跟"特定部門清單"這兩個詞看上去都是只有"部門資訊"，但是流程的下一步居然把特定職級人員塞選出來，此時就會讓人疑惑，只有"部門"的資料怎麼有辦法篩選"人員"資料？此例子就可以看出，撰寫者是依據當下取得的資訊進行撰寫，而非注意到當時取得的資訊已經被處理整理過了，導致於直接檢視文件時就會出現許多的疑惑與懷疑，這也呈現出交接文件上的失真以其效力偏低。

二、以檢視文件人員的觀點出發：

在管理文件的撰寫上都會有撰寫規範，而這些規範的定義原始都是為了讓檢視文件的人清楚文件撰寫時各個部分都有固定定義，以方便檢視與思緒轉換，可是撰寫人員因為太過清楚狀況，所以常常會不自覺的省略部分需要說明的資訊，導致檢視文件的人在檢視時都會出現許多疑問跟觀念認知上判定異常，因此產生許多摩擦問題，甚至有些較敏感的人會覺得被侵犯或不被信任感的出現，出現許多溝通隔閡以及組織衝突等狀況。

三、如何讓閱讀者不用再找撰寫者

撰寫文件時，詳細清楚不是撰寫者說的算，而是閱讀者說的算，為甚麼這麼說呢！因為無論是甚麼文件都不是寫來給自己看的，而是寫來讓接手的人看，因此出現常說的交接作業若能順利接下60%就該偷笑了這樣的說法，因為所有的事情都不會比當下進行指導作業，畢竟凡事都有特殊狀況的出現，而越熟悉的人越會自然而然避開特殊狀況，這些特殊狀況會漸漸地被遺忘甚至發生率極低，導致文件撰寫上這些特殊狀況是否該留下感到疑惑，甚至就不自覺得不再留下或輕描淡寫的過去了，這導致於文件留下了，問題也留下了！

最後總結觀念其實就那麼一句話，"好的文件讓人走向未來，壞的文件讓人原地踏步"。