gen-docs

Go プロジェクトの構造をスキャンし、パッケージの概要、依存関係、使用上の注意を含む README.md を生成・更新します。

gen-docs とは?

このスキルは、Go プロジェクトの構造を自動的にスキャンし、README.md を生成または更新するためのものです。ユーザーがプロジェクトの概要をドキュメント化したい場合や、ソースコードからプロジェクトレベルのドキュメントを作成したい場合に使用します。主な機能として、プロジェクトルートのファイル一覧取得、go.mod からのモジュール名や Go バージョン、依存関係の読み取り、各パッケージの主要なソースファイルから API や動作の要約を行います。その後、プロジェクトタイトル、ディレクトリ構造、パッケージ説明、バイナリ/CLI の説明、依存関係と要件を含む README.md を更新または新規作成します。最後に、ファイルパスを確認し、例や使用法などさらに詳細が必要かユーザーに問い合わせます。このスキルは Claude Code、Cursor、Codex などの AI エージェントで利用でき、開発者が手動でドキュメントを整備する手間を大幅に削減します。

対応~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に質問する

このエージェントスキルを事前に読み込んだ状態で新しいチャットを開きます。

ドキュメント

gen-docs は何をしますか?

ユーザーがプロジェクトをスキャンしてドキュメント(例:README.md)を更新するよう依頼した場合にこのスキルを使用します。

手順

  1. プロジェクトルートをリストし、パッケージ、バイナリ、アセット、設定ファイルを特定します。
  2. go.mod を読み取り、モジュール名、Go バージョン、依存関係を取得します。
  3. 各パッケージの主要なソースファイルを読み取り、API と動作を要約します。
  4. README.md を更新または作成し、以下を含めます:
    • プロジェクトタイトルと1行の概要
    • ディレクトリ構造(ツリーまたはリスト)
    • 主要な関数/型を含むパッケージの説明
    • バイナリ/CLI の説明
    • 依存関係と要件
  5. ファイルパスを確認し、さらに詳細(例、使用法)が必要かユーザーに問い合わせます。

使用するタイミング

  • ユーザーが「プロジェクトの概要についてreadmeを更新して」と言った場合
  • ユーザーが「プロジェクトをスキャンしてドキュメントを更新して」と依頼した場合
  • ユーザーがソースからプロジェクトレベルのドキュメントを生成したい場合

Individual skills in this repo

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

関連スキル