技術分享
Helper CTO 系列文章 13|接手別人寫的程式碼,第一個月我們會做什麼
把系統交給新團隊,老闆最怕錢花下去卻什麼都沒看到。本文用一張時間軸表攤開接手的第一個月:第一週只看只問不動、第二週補備份監控部署、第三四週只處理最該先做的三件事,以及月底你會拿到什麼。
「文件?他走的時候說都在程式碼裡了。」這句話的代價,會在下一個工程師進來的第一週具體出現:他花三天猜這套系統到底怎麼跑起來,而這三天裡系統如果出事,沒有任何人有能力處理。你不是不重視文件,而是沒有人告訴過你最少需要哪幾樣。以下五樣,每樣一頁以內。
考古的意思是:新來的人要花好幾天猜這套系統怎麼跑起來,一邊猜一邊試,試錯的代價由你付。他要猜的是:
更糟的是有些東西猜不出來:舊工程師電腦裡的部署指令、只有他知道的登入方式,沒留下來就沒了。
你不需要一本技術規格書,那種東西沒人會維護。你需要五張紙,讓沒看過這套系統的工程師一天內接得上手:
| 文件 | 上面寫什麼 | 沒有它的代價 |
|---|---|---|
| 系統在哪跑 | 主機平台、帳號、網域、用到的外部服務 | 一項一項打電話去問,問不到就開新的 |
| 怎麼部署 | 從哪拿程式、跑什麼、怎麼確認成功、怎麼退回 | 沒人敢上線,或上線了退不回來 |
| 資料在哪 | 資料庫位置、檔案存哪、備份頻率與存放地點 | 出事才發現備份根本沒在跑 |
| 誰能登入 | 有哪些帳號、各自權限、密碼去哪裡拿 | 離職的人還進得來,該進的人進不去 |
| 常見問題怎麼處理 | 過去半年出過的事,和當時怎麼解決 | 同一個問題每次都重新查一遍 |
五樣加起來不超過五頁。記得這是寫給「明天才來的工程師」看的,不是自己的備忘。
如果五樣一次寫不完,先寫這兩樣,其他三樣可以慢慢補:
「把東西拿回來」和「把東西寫下來」是要一起做的兩件事,工程師離職後要先拿回來的 12 樣東西那篇講的是前者。我們接手系統的第一個月(見接手後第一個月我們會做什麼),第一週產出的「現況地圖」就是這五樣的初版。
文件最大的敵人不是沒寫,是寫了沒人更新,半年後跟現況對不上,反而誤導下一個人。三個做法:
判斷文件有沒有活著很簡單:問自己「如果負責的人請假一週,有人能照著這五頁把系統顧好嗎?」答案是否定的,就該更新了。
很多廠商不留文件,理由說出來很難聽:文件越少,客戶越離不開。我們的做法相反,原因也很實際:
交接該注意的其他細節,系統維運交接指南那篇有完整清單。
文件的價值不在於寫得多漂亮,在於你隨時換得了人。
交接不變成黑盒子,靠的不是厚厚的手冊,是五頁一直有人更新的紙。恩梯科技以 Helper CTO 的角色接手你的系統,第一個月就把這五樣寫出來,之後每個月跟著改動維護。第一步是 60 分鐘的系統健檢:讓我們看得到程式碼就好,不需要正式環境的帳號密碼,3~5 個工作天內你會拿到一頁看得懂的報告。如果你的系統現在還是「都在程式碼裡」,先讓我們幫你把第一頁寫出來:Helper CTO:系統維運方案。
需要協助嗎?
點擊這裡與我們聯繫!