gen-docs は何をしますか?
ユーザーがプロジェクトをスキャンしてドキュメント(例:README.md)を更新するよう依頼した場合にこのスキルを使用します。
手順
- プロジェクトルートをリストし、パッケージ、バイナリ、アセット、設定ファイルを特定します。
go.modを読み取り、モジュール名、Go バージョン、依存関係を取得します。- 各パッケージの主要なソースファイルを読み取り、API と動作を要約します。
README.mdを更新または作成し、以下を含めます:- プロジェクトタイトルと1行の概要
- ディレクトリ構造(ツリーまたはリスト)
- 主要な関数/型を含むパッケージの説明
- バイナリ/CLI の説明
- 依存関係と要件
- ファイルパスを確認し、さらに詳細(例、使用法)が必要かユーザーに問い合わせます。
使用するタイミング
- ユーザーが「プロジェクトの概要についてreadmeを更新して」と言った場合
- ユーザーが「プロジェクトをスキャンしてドキュメントを更新して」と依頼した場合
- ユーザーがソースからプロジェクトレベルのドキュメントを生成したい場合