Helper CTO 系列文章 17|交接不要變黑盒子:一份可以留給下一個人的最小文件集

技術分享
Author
恩梯科技
2026-10-04 2 次閱讀 5 分鐘閱讀
Helper CTO 系列文章 17|交接不要變黑盒子:一份可以留給下一個人的最小文件集

「文件?他走的時候說都在程式碼裡了。」這句話的代價,會在下一個工程師進來的第一週具體出現:他花三天猜這套系統到底怎麼跑起來,而這三天裡系統如果出事,沒有任何人有能力處理。你不是不重視文件,而是沒有人告訴過你最少需要哪幾樣。以下五樣,每樣一頁以內。

沒有文件,換人接手就是重新考古

考古的意思是:新來的人要花好幾天猜這套系統怎麼跑起來,一邊猜一邊試,試錯的代價由你付。他要猜的是:

  • 主機在哪個平台、用哪個帳號登入、每個月帳單誰在付。
  • 網域登記在誰名下、什麼時候到期、續約由誰負責。
  • 資料庫密碼放在哪裡、備份到底是不是真的有在跑。
  • 部署是手動還是自動、上一次成功放上去是什麼時候。
  • 哪些第三方服務還在扣款,哪些其實早就沒在用了。

更糟的是有些東西猜不出來:舊工程師電腦裡的部署指令、只有他知道的登入方式,沒留下來就沒了。

最小文件集:五樣,每樣一頁

你不需要一本技術規格書,那種東西沒人會維護。你需要五張紙,讓沒看過這套系統的工程師一天內接得上手:

文件上面寫什麼沒有它的代價
系統在哪跑主機平台、帳號、網域、用到的外部服務一項一項打電話去問,問不到就開新的
怎麼部署從哪拿程式、跑什麼、怎麼確認成功、怎麼退回沒人敢上線,或上線了退不回來
資料在哪資料庫位置、檔案存哪、備份頻率與存放地點出事才發現備份根本沒在跑
誰能登入有哪些帳號、各自權限、密碼去哪裡拿離職的人還進得來,該進的人進不去
常見問題怎麼處理過去半年出過的事,和當時怎麼解決同一個問題每次都重新查一遍

五樣加起來不超過五頁。記得這是寫給「明天才來的工程師」看的,不是自己的備忘。

五樣裡先寫哪兩樣

如果五樣一次寫不完,先寫這兩樣,其他三樣可以慢慢補:

  • 怎麼部署:如果這個動作目前只有一個人會做,它就是整套系統最脆弱的地方。步驟寫下來:從哪裡拿程式、跑什麼、怎麼確認成功、失敗怎麼退回上一版。
  • 誰能登入:帳號權限沒整理過,離職的人可能還進得來。這一頁只寫「密碼去哪裡拿」,密碼本身放在密碼管理工具裡。
  • 兩樣不用開會就寫得完:各一頁,一個下午就有初版,之後再補其他三樣。

「把東西拿回來」和「把東西寫下來」是要一起做的兩件事,工程師離職後要先拿回來的 12 樣東西那篇講的是前者。我們接手系統的第一個月(見接手後第一個月我們會做什麼),第一週產出的「現況地圖」就是這五樣的初版。

怎麼維持它不過期

文件最大的敵人不是沒寫,是寫了沒人更新,半年後跟現況對不上,反而誤導下一個人。三個做法:

  • 跟著改動走:每次換主機、加服務、改部署方式,順手改那一頁,當成該次改動的一部分。
  • 每季翻一次:跟安全更新綁在一起做。安全更新每季至少 1 次,做完順便把五頁看一遍。
  • 放在大家找得到的地方:跟程式碼放一起,或放在公司共用空間。放在某個人的個人硬碟裡等於沒有。

判斷文件有沒有活著很簡單:問自己「如果負責的人請假一週,有人能照著這五頁把系統顧好嗎?」答案是否定的,就該更新了。

為什麼我們合作結束會把這些留給你

很多廠商不留文件,理由說出來很難聽:文件越少,客戶越離不開。我們的做法相反,原因也很實際:

  • 我們按月請款、想停隨時可以停,靠「你走不了」撐不住這個模式。
  • 能靠的只有一件事:你每個月都覺得這筆錢花得值得。
  • 文件留給你,你才有選擇;有選擇之後還留下來,才是真的合作。

交接該注意的其他細節,系統維運交接指南那篇有完整清單。

恩梯科技交給你的那五頁

  • 第一個月就寫出五樣:接手第一週先產出初版,不是等合作結束才回頭補。
  • 跟著每次改動更新:換主機、加服務、改部署方式,對應那一頁當天就改掉。
  • 每季隨安全更新複查:每季至少 1 次,把五頁跟現況對過一遍。
  • 結束時全部留給你:文件和紀錄都是你的,換人接手不會變成黑盒子。

文件的價值不在於寫得多漂亮,在於你隨時換得了人。

交接不變成黑盒子,靠的不是厚厚的手冊,是五頁一直有人更新的紙。恩梯科技以 Helper CTO 的角色接手你的系統,第一個月就把這五樣寫出來,之後每個月跟著改動維護。第一步是 60 分鐘的系統健檢:讓我們看得到程式碼就好,不需要正式環境的帳號密碼,3~5 個工作天內你會拿到一頁看得懂的報告。如果你的系統現在還是「都在程式碼裡」,先讓我們幫你把第一頁寫出來:Helper CTO:系統維運方案。

想把這些做法落地到你的公司?

認識 Helper CTO:系統交給誰負責
加 LINE 詢問

我們不追求大量專案。

只與少數值得深入合作的夥伴建立長期關係。

預約系統健檢

需要協助嗎?

點擊這裡與我們聯繫!

立即聯繫