前言¶
DeepSeek Harness (DSH) 的理念是「一切皆插件」。在插件生態中，dsh-project-compass 提供了代碼庫分析能力。當你接手一個陌生項目時，最大的成本往往不是讀代碼，而是不知道從哪裏開始，以及不知道修改哪裏會破壞什麼。
插件介紹¶
這是一個 AI 驅動的 DSH 插件，用於代碼庫分析、開發者入職和項目級問答。插件維護者爲 lpeixin，採用 MIT 許可證。
核心功能¶
插件無需在線，也無需先運行項目，即可對現有代碼庫進行分析。
- 代碼庫分析：掃描項目結構。
- 生成文檔：
-ARCHITECTURE.md：架構說明，包含分層與依賴關係。
-MODULE_MAP.md：模塊地圖，列出模塊職責、文件列表、依賴關係。
-KEY_FLOWS.md：關鍵流程提取，包含流程圖與證據。
-GETTING_STARTED.md：項目上手指南。 - 項目級 AI 問答：提供帶引用的問答接口，返回答案時附帶證據引用。
典型用法¶
在項目根目錄下執行以下命令進行分析並生成報告：
node scripts/compass-cli.mjs analyze . && node scripts/compass-cli.mjs report .
插件會將生成的文檔輸出到 <project>/docs/project-compass/ 目錄。這些生成的 artifacts 默認會被 .gitignore 忽略。
適用場景與注意¶
- 適用場景：新開發者入職、接手遺留項目、技術負責人評估變更影響範圍、需要項目上下文的 AI 智能體。
- 注意：插件以當前 dsh 進程的權限運行，請確保在執行前檢查源碼與許可證。文檔主要用中文編寫。
結尾¶
dsh-project-compass 通過提供帶證據引用的文檔，解決了“理解項目”這一非結構化問題。更多細節請參考項目主頁。
