產生文件
當使用者要求掃描專案並更新文件(例如 README.md)時,使用此技能。
步驟
- 列出專案根目錄,識別套件、二進位檔、靜態資源與設定檔。
- 讀取
go.mod以擷取模組名稱、Go 版本與相依性。 - 讀取每個套件中的關鍵原始檔,摘要其 API 與行為。
- 更新或建立
README.md,包含:- 專案標題與單行概述
- 目錄結構(樹狀或列表)
- 套件說明,包含關鍵函數與型別
- 二進位檔/CLI 說明
- 相依性與需求
- 確認檔案路徑,並詢問是否需要更多細節(範例、用法)。
使用時機
- 使用者說「更新 README 關於專案概覽」
- 使用者要求「掃描專案並更新文件」
- 使用者想要從原始碼產生專案層級文件