工程 · 1 min read
寫給誰:只寫讀者查不到的
你的文件到底寫給誰?AI agent 也是讀者。只寫讀者不容易查到的東西,其他給連結就好,讓每種讀者都拿到自己需要的。
我在分享會上先問了一題:「你上一份寫的文件,真的有人讀嗎?」
台下很安靜。一份文件要讓對的人讀到,才有用。這個系列的其他規則,都從這句話開始。
記憶系統怎麼記東西
TencentDB Agent Memory 把記憶分成四層。原始對話先變成短的事實,再變成更大的模式。
下層保留證據,上層保留結構。人也一樣。多年的工作經驗,會變成你「本來就知道」的東西。這一層不需要寫下來。
每種讀者,基礎不一樣
| 讀者 | 已經知道:跳過 | 只有我們知道:要寫 |
|---|---|---|
| 資深工程師 | clean code、design pattern、git、HTTP | 這個服務為什麼存在、跨 repo 流程、過去的決定 |
| 新進成員 | 一般資工知識 | 公司內部用語、從哪裡開始 |
| PM 與業務角色 | 產業與產品 | 功能做什麼、限制、誰負責 |
| AI agent | 訓練資料裡的知識 | repo 的指令、只存在聊天或腦袋裡的決定 |
AI 時代多了一種讀者。AI agent 讀得很快,但它讀不到團隊聊天室(Slack、Teams)裡的討論,也讀不到你腦袋裡的理由。這些就是你要寫的東西。
規則:只寫讀者無法輕易查到的
讀書會的說法是:容易查到的,給連結。不容易查到的,寫出來。
答案會隨讀者改變。工程師可以讀程式碼,PM 不行。所以同一件事,對工程師要給連結,對 PM 要寫清楚。
每種讀者也在不同的地方找。工程師和 AI agent 看 repo 文件。新進成員和 PM 看團隊 wiki(Notion、Obsidian、Confluence)。
一個好名字,可以讓讀者連文件都不用讀,見好名字就是不用寫的文件。
先問誰會讀,再決定寫多少。
參考來源
延伸閱讀: 看看好名字怎麼取代一份文件,讀記住去哪找,不是記內容。或回到系列總覽:AI 時代,文件怎麼活下來