工程 · 2 min read
記住去哪找，不是記內容
資深工程師不背文件，只記住去哪裡找。搜尋工具怎麼找到東西、全隊 tag 清單為什麼會分裂，以及哪些東西根本不值得記。
資深工程師不會背下每一份文件。他們記住地圖，不記每一條街。要記的是在哪裡找，以及幾個關鍵字。
搜尋怎麼運作
| 搜尋 | 怎麼找 | 弱點 |
|---|---|---|
| 編輯器檔案搜尋（VSCode） | 字母順序對就好，中間可以跳：mysrdme 找得到 my-service/README | 你要半記得名字 |
| 信箱搜尋（Gmail） | 完整的字，加上 from:、subject: 等過濾 | 只打一部分的字，通常找不到 |
| 全文搜尋引擎（Elasticsearch） | 每個字指向文件的索引，稀有又重複的字排前面，容許小錯字 | 只找得到有人寫下的字 |
| 程式碼導覽（LSP、treesitter） | 看懂程式碼，直接跳到函式 | 只對程式碼有用 |
連結越直接，要記的越少。這就是大道至簡。
Tag 的認知差距
我們原本希望有一份全隊共用的 tag 清單。但我們已經用好幾種方式叫同一件事。
- 一種文件類型，三個名字：
[Design Doc]、[FE Design Doc]、[BE Design] - 一個主題，兩個標題：「Github Migration」和「GitHub Migration SOP」
除非每個人都背下來，而且有人維護，否則 tag 清單也會這樣分裂。這和好名字就是不用寫的文件說的命名問題是同一個。
值得記嗎
- 產品：資料夾已經是了。
- 字詞：搜尋已經找得到。
- 文件類型：Diátaxis 用兩個問題就能分出四類：讀者是要動手做事，還是想搞懂原理？是第一次學，還是工作中查？
要記四個名字，還是兩個問題？每多一個 tag，就多一件要記的事。
給團隊的選項：全隊 tag 清單、只標文件類型、文件類型加少數主題 tag、不用 tag 只靠資料夾和搜尋。
每一個 tag，都是要大家多記一件事。
參考來源
延伸閱讀： 回頭讀好名字就是不用寫的文件，讀寫給誰：只寫讀者查不到的。或回到系列總覽：AI 時代，文件怎麼活下來