Community生產力與協作github.com

karrot0195/agent-skills-(生成文件)

掃描 Go 專案結構,自動產生或更新 README.md,包含套件總覽、相依性與使用說明。

agent-skills-(生成文件) 是什麼?

此技能專門用於掃描 Go 專案並自動產生或更新專案文件(例如 README.md)。它會先列出專案根目錄中的套件、二進位檔、靜態資源與設定檔,接著讀取 `go.mod` 擷取模組名稱、Go 版本與相依性,然後逐一讀取各套件的關鍵原始碼以摘要其 API 與行為。最後,技能會建立或更新 README.md,包含專案標題與單行概述、目錄結構(樹狀或列表)、套件說明(含關鍵函數/型別)、二進位檔/CLI 說明,以及相依性與需求。技能完成後會確認檔案路徑,並詢問是否需要更詳細的範例或使用說明。此技能支援在 Claude Code、Cursor 或類似 AI 代理平台上執行,適用於使用者要求「更新 README」、「掃描專案並更新文件」或「根據原始碼產生專案層級文件」等場景。

相容平台~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/karrot0195/agent-skills-/tree/HEAD/.agents/skills/gen-docs

Installed? Explore more 生產力與協作 skills: steipete/gemini, steipete/gh-issues, steipete/skill-creator · View all 6 →

在你喜歡的 AI 中提問

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

說明文件

產生文件

當使用者要求掃描專案並更新文件(例如 README.md)時,使用此技能。

步驟

  1. 列出專案根目錄,識別套件、二進位檔、靜態資源與設定檔。
  2. 讀取 go.mod 以擷取模組名稱、Go 版本與相依性。
  3. 讀取每個套件中的關鍵原始檔,摘要其 API 與行為。
  4. 更新或建立 README.md,包含:
    • 專案標題與單行概述
    • 目錄結構(樹狀或列表)
    • 套件說明,包含關鍵函數與型別
    • 二進位檔/CLI 說明
    • 相依性與需求
  5. 確認檔案路徑,並詢問是否需要更多細節(範例、用法)。

使用時機

  • 使用者說「更新 README 關於專案概覽」
  • 使用者要求「掃描專案並更新文件」
  • 使用者想要從原始碼產生專案層級文件

Individual skills in this repo

This repo contains 1 individual skill — each has its own dedicated page.

相關技能