Community寫作與編輯github.com

simonpokorny/knowledgebase

為編碼代理提供 Git 版本化的制度記憶:以綱要強化的發現、學習與決策,由代理撰寫,供人類審查。

knowledgebase 是什麼?

此技能為 AI 代理(如 Claude Code、Cursor、Codex)提供一個結構化的方法,用於將知識直接持久化到程式碼儲存庫中。它強制使用精簡的綱要格式,將新資訊分類為**發現**(關於系統的真實斷言)、**學習**(行為規則,通常源自錯誤)和**決策**(有權衡的選擇)。資料寫入 `.knowledgebase/` 目錄下的 Markdown 檔案。 此技能最顯著的優點是其自動化工作流程:代理會根據工作階段中的實際驗證狀態設定 `verified` 或 `unverified` 等狀態。只有當代理在當前工作階段親自查證了斷言時,才會標記為代理驗證;否則狀態保持未驗證,明確標記需要人工審查。決策可標記為 `decided-by: agent`(由代理做出的實作選擇)或指示為 `decided-by: human`(需要人工確認)。Guard 規則(針對學習)會自動加入可測試的 regex,以防止禁止的命令被執行。每個條目都與產生該知識的變更提交在同一個分支上,確保完美的可追溯性。此模式消除了重複工作,捕捉了隱性制度知識,並建立了可審計、可版本化的專案記憶,而這在以往是傳統文件或口頭傳統所無法達到的。

相容平台~Claude Code~Codex CLI~Cursor
npx skills add simonpokorny/knowledgebase

Installed? Explore more 寫作與編輯 skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

在你喜歡的 AI 中提問

開啟一個已預先載入此 Agent Skill 的新對話。

說明文件

將一個小型、綱要簡潔的條目寫入儲存庫的 .knowledgebase/。如果儲存庫沒有 .knowledgebase/,請停止操作並告知使用者應先執行 /setup-knowledgebase 技能。

  1. 選擇類型:

    這是類型路徑
    關於系統的真實斷言,值得記錄而非重新發現finding.knowledgebase/entries/finding-<主題-kebab>.md
    行為規則,通常源自錯誤learning.knowledgebase/entries/learning-<主題-kebab>.md
    在替代方案中的選擇,帶有權衡decision.knowledgebase/entries/decision-NNNN-<主題-kebab>.md
  2. 撰寫條目。Frontmatter 欄位、狀態、限制與主體慣例均記載於 ENTRY-FORMAT.md;請在撰寫前閱讀該文件。此外掛的 templates/ 目錄中附有實際範例。

  3. 檢查狀態是否如實反映。對於 findings 和 learnings:僅當你在當前工作階段親自證明了該斷言時,才使用 verified,並設定 verified-by: agent,同時在正文中提供證據(來源連結或你所執行的檢查)。任何你無法證明的內容應保持 unverified;這些條目需要人類在審查時進行驗證。新的 decisions 的狀態為 decided,並分為兩類:

    • 實作決策(Implementation decisions):你在建構過程中所做的基本選擇。記錄其原因與權衡,並標示為 decided-by: agent。
    • 規劃決策(Planning decisions):與使用者共同做出的決定,無法從程式碼推斷。也將其記錄為 decided-by: agent,然後在 session 結束的報告中向使用者提供採用行,以便該條目最終成為 decided-by: human。 絕對不要自行設定 decided-by: human;只有人類可以設定。這兩類決策日後都可能被更新的決策所 superseded(取代)。
  4. 如果條目是一個禁止某個指令的 learning(學習),請加入 guard: 正規表示式,使規則能夠自我強制執行。Guard 的撰寫規則位於 ENTRY-FORMAT.md 中;在提交前請使用 grep -E 測試該正規表示式。

  5. 將條目提交至與產生該變更相同的分支,使其與該提交保持同步。請勿將條目積累後再批次提交。

相關技能