# 新工程師報到，我該準備哪些東西來加快交接進度呢？

- 作者：林鼎淵（Dean Lin）
- 網址：https://deanlin.net/blog/202103/new-engineer-onboarding-checklist/
- 發布：2021-03-31
- 主題：團隊合作
- 標籤：新人報到、工作交接、技術文件、注意事項
- 摘要：隨著公司的擴張，會有越來越多人加入團隊來分擔你的工作 😊，此時你需要準備交接文件📄，以保證他們會成為團隊中的神隊友 😎 而不是讓你增加工作份量的豬隊友 🤕，這篇文章我會列出個人在交接時會準備的東西🧰。

隨著公司的擴張，會有越來越多人加入團隊來分擔你的工作 😊，此時你需要準備交接文件📄，以保證他們會成為團隊中的神隊友 😎 而不是讓你增加工作份量的豬隊友 🤕，這篇文章我會列出個人在交接時會準備的東西🧰。

  image from: miss rabbit

## 一、遠端工作 — VPN 連線

因為疫情關係越來越多公司的 IT 部門採取遠端工作，但許多工作上的資料以及開發環境都在公司內網，所以在新人報到前你需要提供給他們可以使用內網的 VPN，主要是提供 PPTP、L2TP 這兩種。

> 特別注意 mac 是不支持 PPTP 的連線，需要安裝其他 VPN 軟體才能使用，筆者是安裝 shimo 這個軟體

## 二、註冊公司內部協作平台的帳號

如果公司內部有專案管理系統(ex：Jira、Zentao、Redmine)或是軟體開發平台(ex：GitLab)，請先幫他們完成註冊，並列成清單讓他方便登入。

## 三、整理需要讓對方遠端登入的伺服器

通常工程師在發布功能時會經過三道關卡：

- **DEV**：工程師內部開發測試使用，功能都尚未測試
- **QA**：工程師開發完成並且通過自己的 test case 驗證，此階段會給公司專門的團隊進行各式各樣的測試
- **PROD**：測試部門確認功能穩定且通過壓力測試後就能發布到正式的 Server

這三個情境會對應到不同的 server，如果新人發布到錯誤的 server 會造成不可挽回的後果，所以建議 PROD 的 server 等新人熟悉作業流程後再給他登入的權限。

> 在報到第一天時用公司的電腦產生 ssh key，並設定到 DEV、QA 的 server 上面，建議**設定 alias name 做登入**，避免發生遺憾

## 四、技術相關

- **程式碼風格**：一樣米養百樣人，工程師來自五湖四海自然風格迥異，公司可以使用 ESLint 這類的工具來約束風格，但實際上程式碼的效能、長度、分類…很多事情還是需要有人說明過去的撰寫風格
- **Deploy 的方式**： 如果團隊有導入 CI/CD，你就要跟對方解釋清楚哪些 branch 會觸發對應的 server，如果 branch merge 時會自動 deploy 請小心謹慎
- **技術文件**：種類繁多，大概可以分成：程式碼內部註解、api 功能說明文件、過去開發的 SPEC 這 3 種；**基本上這些文件是為了讓對方能快速了解專案的結構而不是讓他了解每一行程式碼的意義**。

## 五、工作相關

- **列出例行公事清單**：像是很多公司都有跑 scrum sprint，你可以向新人說明例會時間點、參與人員、討論內容；藉此讓他快速進入開會討論時的狀況
- **列出手上待完成事項**：新人會接替你的工作，你可以先將手中待完成的任務難易度排序，先將簡單的任務交給他，觀察他的完成度及適應性
- **提點行政庶務**：每個新人在剛入職時誰都不認識，印表機不知道怎麼操作、專案管理系統不會用、電腦不會設定開發環境；你可以撰寫『秘笈』讓他了解遇到問題時可以向哪個窗口提問
- **了解合作團隊職權分類**：以一個雲端團隊來說，你需要讓新人知道前端遇到問題要找誰、後端發生 bug 要問誰，整理好團隊裡面的聯絡窗口才能讓新人更快的融入團隊
- **保密協議**：如果公司開發的專案有其機密性，記得提醒新進人員不可洩露專案內容出去。

---

關於作者：林鼎淵（Dean Lin），台灣的生成式 AI 企業內訓講師、外商資安公司軟體專家，也是生成式 AI 創新學院發起人。出版 7 本書（包含全台第一本 ChatGPT 應用專書），兩度獲得 iThome 鐵人賽佳作，累積上百場授課與顧問經驗。（https://deanlin.net/about/）
引用時請附上原文網址：https://deanlin.net/blog/202103/new-engineer-onboarding-checklist/