keep-the-why
專案記憶的「為何」層:以 Markdown 形式存放於儲存庫中的程式碼庫背後推理,由 Git 進行版本控制,供程式碼代理與人類使用,如此便不會有被拒絕的提案被重複提出。
keep-the-why 是什麼?
專案記憶的「為何」層:以 Markdown 形式存放於儲存庫中的程式碼庫背後推理,由 Git 進行版本控制,供程式碼代理與人類使用,如此便不會有被拒絕的提案被重複提出。無需資料庫、無需背景服務、無需帳號。
keep-the-why 概覽
這是什麼
Keep the Why 是一個將程式碼背後的決策理由以 Markdown 格式保存在 context/ 目錄中的工具,並透過 Git 進行版本控制。它記錄了架構決策、被否決的替代方案、解決方法、事件教訓以及程式碼本身無法說明的營運限制。該專案被描述為儲存庫原生的專案記憶之「為什麼」層,專為程式碼代理程式與人類設計。不需要資料庫、常駐程式或帳號。
主要功能
- 將決策理由以純文字 Markdown 儲存在
context/中,與程式碼一起提交並由 Git 進行版本控制。 - 支援多種 AI 程式碼代理程式:Claude Code、Codex、GitHub Copilot、Cursor、OpenClaw、Hermes Agent、Cline、OpenCode、Pi、Antigravity 以及 60 多種其他代理程式。
- 提供四種運作模式:持續捕捉、回溯恢復、知識轉移訪談與維護。
- 預設為主動捕捉:代理程式在理由明確時自動記錄,僅在不確定時提問。
- 支援無人參與的自動代理程式,記錄的條目會標記為
pending-confirmation。 - 提供一次性設定精靈,可設定捕捉風格、確認層級與整合選項等預設值。
使用情境
- 防止已決定的架構問題被反覆討論。
- 避免因移除看似多餘但實際修復錯誤的解決方法而導致靜默回歸。
- 減少新貢獻者(人類或 AI)因缺乏背景知識而停滯的入門時間。
- 防止全新工作階段重複提出已被嘗試且否決的方案。
- 在維護者離職、退休或轉換團隊前進行知識轉移。
快速開始
請參閱儲存庫的 README 以取得安裝說明。
授權與價格
採用 MIT 授權。該專案為開源軟體。
內容整理自該專案公開的 README 與儲存庫資訊。