如何建立文件修訂紀錄
如何建立文件修訂紀錄:它需要哪些欄位、為何紀錄冊是一份獨立於文件本身、只可新增的紀錄,以及大部分手製表格完全略過的核實步驟。
運作方式
把紀錄冊跟文件分開
把修訂紀錄放進它自己的成品裡——封面頁上的一張表格,或者一本獨立的登記冊——絕不能是埋在正文裡的一段文字。文件會改動;兩者之中,只有紀錄冊可以只增長,不倒退。
在第一條項目之前,先訂定欄位
版本編號、日期、作者、以淺白語言寫的變更描述與原因、一個指向它取代的版本的引用,以及誰核實了這條項目。漏掉最後兩者的任何一個,就沒有辦法分辨一條經查核的紀錄,跟作者的自述。
在改動之前開立項目,不是之後
在一項變更獲批的那一刻,就記錄一條待處理項目——編號、文件連結、指派的作者——早於任何人打開檔案。一條事後才寫下的項目,是憑記憶重建的,而這正是紀錄冊存在的目的所要防止的失效模式。
寫下改了甚麼,不只是有東西改了
「更新了第 4 節」不是一段描述;「把第 4 節的審批門檻由 500 美元改成 2,000 美元」才是。以淺白字句記錄改動前後、作者姓名與日期,令讀者不用打開文件自身的歷史,也能重建那次變更。
對照真實改動核實項目
在項目結案之前,找一個不是作者的人,把紀錄冊裡的描述跟文件裡實際改動的內容比較。如果兩者不一致,查清楚是文件錯了還是項目錯了——更正項目,對作者來說不一定是一種倒退。
抽查已結案項目,不用逐一覆核
建立一次定期審核,按屬於審核計劃、而不是臨時起意的一個時間表,抽查一批已結案項目,對照它們的文件。這正是令這本紀錄冊,變成一樣你不用自己重新核實一遍也能信任的東西的原因。
常見問題
修訂紀錄跟版本控制有甚麼分別?
修訂紀錄是成品——列有版本、日期、作者、描述與核實人的表格。版本控制則是保持那張表格誠實的做法:不寫一條項目就不改動任何東西的規則、項目事後絕不改寫,以及由作者以外的人拿兩者互相核對。你可以有一張修訂紀錄,背後卻是薄弱的版本控制——表格存在,卻從來沒有人對照真實改動核實過任何一行。
一張修訂紀錄表格需要哪些欄位?
版本編號、日期、作者、以淺白語言寫的變更描述與原因、一個指向它取代的版本的引用,以及——大部分手製表格都會漏掉的那一項——誰對照實際改動核實過這條項目。漏掉最後這一欄的一行,是作者的自述,不是一條經查核的紀錄。
如果一條舊項目有錯,應該修改修訂紀錄去修正嗎?
不應該。新增一行去更正紀錄,而不是改寫舊的那一行;這本紀錄冊值得信賴的程度,取決於它只可新增的歷史有沒有保持完整。如果出錯的是文件而不是項目,修正應該以一次新的文件修訂進行,而不是改寫紀錄冊裡的一行。
一本手動維護的試算表,對修訂紀錄來說夠用嗎,還是需要軟件?
一份試算表在有人修改一行而不是新增一行之前都可以運作,但這種情況很難防止,也很容易被忽略。QueryChart 的版本歷史,會自動寫出等效的紀錄——為每一次修訂配備欄位級的前後值與編輯者姓名的變更日誌,可以在比較版本畫面查看,並隨時可以還原,見 /features/version-control。上面的圖表,展示的是同一套紀律的手動版本——一項申請、一段歸檔的描述、一個核實步驟——無論由哪一個工具運作它。