什麼是變更日誌?
變更日誌是一份簡短且帶日期的清單,說明文件從一個版本到下一個版本改了什麼:哪些章節被修改、新增或刪除了什麼,以及原因。它由人來撰寫,而不是自動生成,能讓審閱人每次開啟新版本時不必重新去發現同樣的改動。
該記錄什麼
寫明版本名稱和日期、涉及的頁面或章節、對每處改動的一句話說明,以及原因或提出要求的人。篇幅要短到一分鐘內能讀完。變更日誌最有用的地方是列出決定,例如刪除了某一條款,而不是每一個改正的錯別字。
找出改動
要寫日誌,首先要找出改動。比較 PDF 逐頁比較兩個版本的文字,並在 CSV 報告中列出哪些頁不同,從而縮小查詢範圍。如果想並排閱讀段落,PDF 轉文字可以提供兩個檔案的文字,擷取 PDF 頁面則可以把有變化的頁面抽出來,做成給審閱人的小檔案。 實用提示:在檔案旁邊保留一份簡短的紀錄,每個版本一行:日期、檔案名稱、誰提出了修改,以及報告顯示哪些頁不同。PDF 比較工具的 CSV 報告可以和這份紀錄一起保存。這樣後來的讀者無須重新開啟每個檔案,就能快速看清從第一版到最終版的過程。請把紀錄保存在你自己的系統裡。
與檔案放在一起
把變更日誌與它所描述的版本放在一起,名稱對應,或者在分享檔案時把它作為第一頁。收到新版本及其變更日誌的審閱人可以直接檢視相關頁面。
用到這個術語的工具
提到這個術語的指南
常見問題
- AuraDoc 會替我寫變更日誌嗎?
- 不會。比較 PDF 會報告哪些頁相同、哪些頁不同,但對每處改動的描述需要你自己撰寫。
- 變更日誌應該放在哪裡?
- 放在它所描述的版本旁邊,採用相同的命名,這樣兩者就不會分開。
- 變更日誌和修訂追蹤是一回事嗎?
- 不是。修訂追蹤是在可編輯檔案中隨編輯實時記錄改動。變更日誌則是為已完成版本的讀者撰寫的獨立摘要。