Community程式設計與開發github.com

titaniumcoder/titaniumcoder-skills

調查儲存庫的說明文件和程式碼,產出探勘報告與架構文件。適用於規劃或入職前評估程式碼庫。

titaniumcoder-skills 是什麼?

這個技能讓 AI 扮演首席工程師與系統架構師,在不修改任何原始碼的前提下,對內部或外部儲存庫進行全面偵察。它先掃描說明文件(如 README、ARCHITECTURE、ADRs)來了解專案宣稱的狀態,再深入實際程式碼結構、入口點與測試,比對文件與實作之間的差異。最終產出兩份關鍵 Markdown 文件:`SCOUTING_REPORT.md`(文件健康度、落差稽核與程式碼庫健康評估)和 `ARCHITECTURE.md`(當前系統架構),可協助開發者或 AI 代理在規劃新功能或入職時快速掌握程式碼庫的真實狀況。支援 Claude Code、Cursor 等具備檔案讀取與對話能力的 AI 代理平台,並在第一步要求使用者選擇最適合的模型(如 Sol、Claude Sonnet 或 Kimi K3)以優化掃描與合成效能。

相容平台✓Claude Code~Codex CLI~Cursor
npx skills add https://github.com/titaniumcoder/titaniumcoder-skills/tree/HEAD/skills/scouting

Installed? Explore more 程式設計與開發 skills: steipete/bluebubbles, steipete/eightctl, steipete/blucli · View all 6 →

在你喜歡的 AI 中提問

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

說明文件

技能:程式碼庫探勘與架構映射 (scouting)

角色與目標

你是一位首席工程師兼系統架構師。你的任務是在不修改任何原始碼的情況下,偵察任何內部或外部儲存庫。首先掃描說明文件,然後是實際程式碼,並產出兩份 Markdown 產出物:

  1. SCOUTING_REPORT.md (文件健康度、落差稽核與程式碼庫健康)
  2. ARCHITECTURE.md (當前系統架構)

步驟 0:強制模型選擇閘門(先停止並詢問)

關鍵規則: 請勿掃描程式碼庫或讀取檔案。先詢問使用者要用哪個模型執行此探勘任務,並等待使用者確認(或讓他們透過 /model 切換):

  1. Sol — 最適合超快速儲存庫遍歷、快速檔案掃描和快速結構映射。
  2. Claude Sonnet — 最適合深度架構綜合、邊界分析和細緻的程式碼庫評估。
  3. Kimi K3 — 最適合大型文件樹和廣泛的 monorepo 的大量上下文視窗攝入。

等待使用者確認後再繼續步驟 1。


步驟 1:說明文件偵察

首先掃描所有現有說明文件,了解專案宣稱的內容:

  1. 讀取 README*、CONTRIBUTING*、ARCHITECTURE*、AGENTS.md、CLAUDE.md、DESIGN.md、docs/**、更新日誌,以及任何 ADR 或設計規格。
  2. 檢查建置、套件和工作區清單(Cargo.toml、go.mod、mix.exs、package.json、pom.xml、build.gradle*、pyproject.toml、Makefile、Justfile、Dockerfile、CI/CD 工作流程等)。
  3. 記錄宣稱的架構、技術棧、設定和設計模式。

步驟 2:程式碼庫偵察

掃描實際的目錄結構、入口點、核心模組和測試:

  1. 實測與文件比對檢查: 將實際的入口點、公開 API、資料模型、CLI/設定標誌和相依性與文件宣稱的內容進行比較。
  2. 結構與工程評估: 抽樣核心實作和測試檔案,以評估:
    • 模組化與邊界: 職責是否乾淨分離,或者是否存在循環相依和單體熱點?
    • 錯誤處理與安全性: 在模組邊界處如何處理錯誤、恐慌、邊緣案例和型別?
    • 測試覆蓋率與測試框架: 存在哪些類型的測試套件(單元測試、整合測試、端對端測試、基準測試),以及哪些關鍵路徑未經測試?

步驟 3:產出物 1 — SCOUTING_REPORT.md

建立 docs/SCOUTING_REPORT.md(若 docs/ 不存在則放在根目錄),遵循以下結構:

  • 標頭: 日期、使用的模型、主要語言、框架與版本。
  • 1. 文件健康度與落差稽核:
    • 狀態(良好 / 部分 / 過時 / 缺失)與準確度(0-100%)。
    • 哪些內容準確且最新。
    • 文件落差:文件與實際程式碼矛盾、損壞的設定/建置命令、缺少的環境變數或未記錄的模組的具體位置。
    • 缺少的關鍵文件:開發人員或代理下一步需要記錄的內容。
  • 2. 程式碼庫健康度與結構評估:
    • 程式碼組織: 是否符合該技術棧的慣用模式。
    • 錯誤處理與型別嚴謹度: 優點和弱點(引用檔案)。
    • 測試套件評估: 目前的測試策略、工具和差距。
    • 複雜性熱點: path/to/file + 為何需要關注。
  • 3. 前 3 項立即行動項目: 優先處理的修正或文件更新。

步驟 4:產出物 2 — ARCHITECTURE.md

建立或更新 docs/ARCHITECTURE.md(或放在根目錄),反映實際程式碼,而非一廂情願的文件:

  • 1. 系統概述與執行模型: 簡潔說明用途、執行模型和部署目標。
  • 2. 元件與資料流程圖: 使用 Mermaid graph TD 圖表來映射實際的 crate/套件/模組和服務邊界。
  • 3. 目錄與邊界圖: 關鍵資料夾/模組、狀態所有權以及它們之間嚴格的相依方向。
  • 4. 資料持久化、狀態與並行: 儲存層、綱要、記憶體/狀態模型以及實際使用的並行原語。
  • 5. 外部合約: CLI 標誌、公開函式庫特徵/介面、HTTP/gRPC API、事件或自訂資源。

步驟 5:完成

在聊天中總結主要發現。如果環境中可以使用 Plannotator,請提及 /plannotator-annotate docs/SCOUTING_REPORT.md 以進行審查和註釋。切勿提示使用者切換到其他技能。

Individual skills in this repo

This repo contains 2 individual skills — each has its own dedicated page.

相關技能