你有沒有遇到過這種情況?一行TTL緩存設(shè)為17分鐘,沒人知道為什么;一個worker被注釋掉,旁邊寫著"別碰,會崩",卻不說原因;提交記錄里全是"fix""update""wip"。你想找當(dāng)初做決定的人,發(fā)現(xiàn)人家早離職了。
更糟的是文檔還在,但互相打架。一頁說認(rèn)證走OAuth,另一頁半年后寫的說用JWT。哪份過時了?為什么改?沒人知道。這時候你發(fā)現(xiàn),錯誤的文檔比沒文檔還坑。
![]()
這不是程序員懶。寫文檔打斷心流,優(yōu)先級永遠墊底。問題是工具不對——所有方案都讓你"事后補",但決策的熱度只在當(dāng)下。一個月后只剩輪廓,六個月后變成傳聞。錯過那個瞬間,什么工具都救不回來。
![]()
一個開發(fā)者做了叫Lore的工具,思路很直接:既然Git提交是唯一的固定節(jié)拍,就把文檔綁在提交上。
用起來長這樣:提交代碼時,前兩行預(yù)填好類型和改動內(nèi)容,直接回車跳過。第三行問Why——這才是你真正要填的。比如"令牌桶算法,滑動窗口在5000請求每秒時內(nèi)存吃不住"。回車,生成一份Markdown文件,帶front-matter,扔進.lore/docs/。
![]()
沒有新界面,沒有上下文切換。決策和代碼一起入庫,查git blame就能追到當(dāng)時的想法。簡單到有點不好意思,但可能正好夠用。
特別聲明:以上內(nèi)容(如有圖片或視頻亦包括在內(nèi))為自媒體平臺“網(wǎng)易號”用戶上傳并發(fā)布,本平臺僅提供信息存儲服務(wù)。
Notice: The content above (including the pictures and videos if any) is uploaded and posted by a user of NetEase Hao, which is a social media platform and only provides information storage services.