Communitygithub.com

專案知識庫維護工具

一個可重複使用的 Agent 技能,協助 Codex 及其他程式碼代理程式初始化、維護與演進專案層級的知識庫。

專案知識庫維護工具 是什麼?

此技能專為 AI 編碼代理程式設計,旨在建立並維護一個結構化的專案知識庫,解決代理程式每次啟動時需要從零開始理解專案的問題。透過記錄專案目的、架構、介面、技術決策、已知錯誤及變更歷史,它能大幅提升後續開發會話的效率與準確性。該技能支援 Codex、Claude Code、Cursor、Gemini CLI 等多種工具,只要這些工具能讀取專案檔案並遵循儲存庫內指示即可運作。技能涵蓋完整的知識庫生命週期,包括初始化、按變更類型更新特定文件(例如 API 變更更新 api.md、錯誤修復更新 bugs.md)、避免知識腐化(如合併重複或過時內容),並在每次重要工作後提供簡潔的更新報告。其設計哲學是保持工具中立,優先記錄穩定的事實與可重複使用的教訓,而非暫態的推理內容。

相容平台✓Claude Code✓Codex CLI✓Cursor✓Gemini CLI
npx skills add chancy24/codex-knowledge-base-skill

在你喜歡的 AI 中提問

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

說明文件

專案知識維護工具

用途

使用此技能來初始化、維護與演進 AI 程式碼代理程式的專案層級知識庫。知識庫能幫助未來的代理程式會話理解專案目的、架構、介面、決策、錯誤與近期變更,無需每次都從零開始探索。

保持工作流程工具中立。此技能應能被 Codex、Claude Code、Cursor、Gemini CLI 及其他能夠讀取專案檔案並遵循儲存庫本機指示的程式碼代理程式使用。

使用時機

當使用者要求以下事項時使用此技能:

  • 初始化專案知識庫
  • 摘要或記錄專案
  • 修復錯誤並保留修復經驗
  • 新增或變更功能
  • 新增或變更 API、Schema、指令或資料格式
  • 記錄技術決策或取捨
  • 將原始專案資料整理為結構化知識
  • 回顧或複盤已完成開發會話
  • 更新 AGENTS.md 或 knowledge/ 目錄下的檔案

輸入

常見輸入包括:

  • 當前儲存庫或目標專案路徑。
  • 現有專案檔案、原始碼、文件、問題、日誌或原始資料。
  • 使用者的當前任務以及在會話中進行的任何實作變更。
  • 現有的 AGENTS.md、knowledge/、raw/ 或 skills/ 內容(如果存在)。

輸出

預期輸出包括:

  • AGENTS.md 專案規則。
  • knowledge/overview.md 專案概覽。
  • knowledge/business.md 商業邏輯與使用情境。
  • knowledge/architecture.md 系統架構與資料流程。
  • knowledge/api.md 介面、Schema、指令與資料結構。
  • knowledge/decisions.md 技術決策與取捨。
  • knowledge/bugs.md 錯誤歷史、根本原因、修復方式與預防規則。
  • knowledge/changelog.md 會話層級的變更記錄。
  • 可選的 raw/ 與專案本機 skills/ 資料夾。
  • 一份簡短的最終報告,列出已更新內容與仍需驗證的部分。

工作流程

  1. 優先讀取專案規則:
    • AGENTS.md(如果存在)。
    • knowledge/overview.md
    • knowledge/architecture.md
    • knowledge/decisions.md
    • knowledge/bugs.md
  2. 如果是初始化儲存庫,請使用 references/templates/ 中的範本,或執行此套件的初始化腳本。
  3. 理解當前任務並識別有哪些變更:
    • 專案目標或商業邏輯
    • 架構或模組邊界
    • API、指令、資料檔案、Schema 或回傳結構
    • 錯誤症狀、根本原因、修復方式或預防規則
    • 技術決策或取捨
    • 使用者行為或 UI 慣例
  4. 僅更新相關的知識檔案。
  5. 移除或調和重複、過時或矛盾的內容。
  6. 重要工作完成後,務必更新 knowledge/changelog.md。
  7. 報告已更新的檔案以及任何缺少的驗證。

如需更詳細的維護指引,請參閱 references/playbook.md。

更新 knowledge/

使用最符合變更的最小檔案:

  • 更新 overview.md 以記錄持久的專案目的、範圍、主要模組與主要輸出。
  • 更新 business.md 以記錄使用者情境、工作流程、領域規則與安全邊界。
  • 更新 architecture.md 以記錄模組關係、資料流程、執行階段模式與整合邊界。
  • 更新 api.md 以記錄端點、函式、指令、事件、資料檔案、Schema 與回傳結構。
  • 更新 decisions.md 以記錄重要的技術選擇與取捨。
  • 更新 bugs.md 以記錄已確認的錯誤與學到的教訓。
  • 更新 changelog.md 以記錄每個重要任務的摘要。

不要將暫態的推理內容傾倒入知識庫。優先記錄穩定的事實、經過驗證的決策以及可重複使用的教訓。

錯誤回顧

當錯誤修復後,請更新 knowledge/bugs.md,內容包含:

  • 問題症狀。
  • 根本原因。
  • 修復方式。
  • 受影響的範圍。
  • 執行的驗證。
  • 防止再次發生的規則。

如果根本原因不確定,請標記為「待驗證」,而非猜測。

介面變更

當 API、指令、函式、Schema、CSV、事件或檔案格式變更時,請更新 knowledge/api.md,內容包含:

  • 介面名稱。
  • 請求方法或呼叫風格。
  • 路徑、指令、函式名稱或檔案路徑。
  • 輸入與參數。
  • 回應或輸出格式。
  • 備註、限制與範例。

請使用精確的名稱與欄位拼寫。

技術決策

當做出重要的技術選擇時,請更新 knowledge/decisions.md,內容包含:

  • 決策背景。
  • 考慮過的選項。
  • 最終選擇。
  • 選擇原因。
  • 後果與後續工作。

記錄那些能幫助未來代理程式避免重新探討已解決問題的決策。

避免知識腐化

  • 優先編輯現有條目,而非新增近似重複的條目。
  • 將過時內容標記為已取代,或替換為當前事實。
  • 將專案事實與推測分開。
  • 決策、錯誤與變更記錄條目應使用日期。
  • 保持用詞中立於代理程式,除非特定的工具整合需要工具專屬備註。
  • 未經明確要求,請勿覆蓋使用者撰寫的專案規則。

最終回應

保持最終回應簡潔。包含:

  • 已更新的檔案。
  • 執行的驗證。
  • 任何仍需手動檢查的項目。

相關技能