您今天在工作上做了什麼?上周呢?我花了幾天時間進行季度業務審查,並完成 AWS Data Exchange 和 AWS Marketplace 的年度規劃活動。我還為一個正在上線的專案加入了一些單元測試。
自從一年多前我第一天加入 AWS 以來,我一直在嘗試把我所做的每一件事都記錄在變更日誌上,讓公司裡的每個人都可以看到。我認為您也應該這樣做!
在開放原始碼世界中,追蹤人類可讀的變更已經是長期以來的最佳實務。這顯示出維護者真正關心客戶 - 使多個版本之間的變更易於存取和理解。身為使用者,我可以在升級時找出變更會如何影響我的應用程式,而不需要與人打交道。我可以追蹤退步或改進。變更日誌可提高透明度、改善清晰度,長遠來說,可增加對他人工作的信任。
我的客戶是 AWS 客戶,但也包括與我合作的開發人員和經理。保持 CHANGELOG 幫助我贏得了他們的信任。一般而言,贏得信任是最具挑戰性的事情之一。信任是慢慢贏得的,也是很快失去的。贏得信任對於較資深的工程職位來說是獨一無二的困難,因為您的工作範圍會擴大,工作性質變得更加獨立,而且成果通常需要在更長的時間內交付。
到目前為止,保留個人 CHANGELOG 有幾個明顯的好處。
-
我的 1:1 已經變得更有成效了。我所有的 1 對 1,包括和我經理的 1 對 1,都會先讓他們閱讀我自上次 1 對 1 以來的變更記錄。這讓他們有機會快速收集背景資料,立即瞭解我一直在做什麼,瞭解我的世界裡發生了什麼,並快速進入更有深度的對話。 -
我的 CHANGELOG 幫助了許多新加入公司的工程師。許多人都說我早期的 CHANGELOG 紀錄有助於瞭解一個人在加入 Amazon 的第一週內實際做了什麼。舉例來說,我花了大量時間接受訓練、設定筆記型電腦備份磁碟機,並在第 2 週進行第一次非瑣碎的程式碼變更。 -
我的 CHANGELOG 可作為個人維基與參考。我經常需要參考現有的文件、人或對話。還記得上周讀過的文件嗎?我知道在哪裡可以找到那個連結! -
我的 CHANGELOG 是一種內部激勵。它幫助我誠實地面對自己,並提供資料讓我反省自己忙碌工作與「實際」工作的差異,教導我在哪裡以及如何學習和改善。
那麼我是如何保存變更日誌的呢?我用一張黃色的便條貼在上面,在一周內加入項目,然後在每週一複製貼到 Wiki 中。我總是注意不要包含任何機密資訊,例如與 AWS 面試的候選人姓名或提及的客戶。
如果您啟動了 CHANGELOG,請告訴我!
最後,這裡有一些 Ruby 來產生直到 EOY 的 TOC。