By name: create-top-readme description: >- リポジトリのトップレベルに配置する README.md を作成または更新するためのスキルです。プロジェクトの意図、使い方、ライセンス、主要ドキュメントへの索引を簡潔に生成します。関連するファイルやディレクトリを検出して、リンク付きのインデックスを最後に追加してください。
このスキルは、リポジトリのトップに置く README.md を作る／整備する際に使います。
使いどころ:
- ユーザーから「README を作って」あるいは「トップレベルのプロジェクト概要を書いて」と要求されたとき
- リポジトリの主要ファイル・ディレクトリを要約して README に反映する必要があると判断したとき
制約（必ず守ること）:
- 文体は日本語で「ですます調」を用いること。
- 絵文字を使わないこと。
- 大袈裟な表現を避け、簡潔かつ丁寧に書くこと。
- 生成される README は読みやすく、セクションは論理的に分かれていること。
実行手順（エージェントがこのスキルを使う際に従うこと）:
- リポジトリルートのファイル／ディレクトリを一覧し、README に載せるべき主要項目を判定する。特に以下を探すこと:
LICENSE,CONTRIBUTING.md,CODE_OF_CONDUCT.md,CHANGELOG.md,README.md（既存版）docs/,frontend/,src/,tests/,.github/,.kiro/などの主要サブディレクトリ
- プロジェクト名は可能ならリポジトリ名を用いる（存在しない場合は短いタイトルを生成する）。1行要約（サマリ）を作成する。
- 以下の最低限のセクションを含めること:
- タイトル（プロジェクト名）
- 概要（1〜2段落、目的と意図）
- クイックスタート（必要条件、インストール、起動、テストの簡潔手順）
- 使い方（代表的なコマンドや使用例）
- 開発（ローカルセットアップ、依存関係、ビルド）
- ライセンス（
LICENSEファイルがある場合はその旨を明記し、無ければ推奨案を提示） - 主要ドキュメントのインデックス（存在する主要ファイル／ディレクトリへのリンク）
- 『主要ドキュメントのインデックス』では、該当するファイルやフォルダがあれば必ずリンクを作る。例:
./frontend/README.md、.kiro/specs/debate-export/tasks.mdなど。 - 既存の
README.mdがある場合は、差分を作り、不要な重複を避けつつ情報を更新する。大きな変更は要約を先に提示して承認を待つ。
テンプレート（最低限、これに沿って生成すること）:
# {プロジェクト名}
{短い1行サマリ}
## 概要
{目的・意図を簡潔に説明（1〜2段落）}
## クイックスタート
前提条件:
- 例: Python 3.11+, Node.js 18+ など（該当しない場合は省略）
インストール:
```sh
# 例: pip install -r requirements.txt
起動:
# 例: python -m ai_debate_agent.api
テスト:
# 例: pytest
使い方
簡単な使用例や主要コマンドを箇条書きで示す。
開発
ローカルでのセットアップ手順（依存関係、ビルド、環境変数の例）。
ライセンス
このリポジトリには LICENSE ファイルがあります（またはありません）。存在する場合はそれを参照する旨を記載し、ない場合は推奨されるライセンスを提案してください。
主要ドキュメント
./.kiro/specs/debate-export/tasks.md— デベートエクスポートの仕様（存在する場合）./frontend/README.md— フロントエンド関連（存在する場合）./tests/— テストに関する情報- そのほか、発見した重要ファイルやディレクトリへのリンクを追加する。
品質チェック（出力前に確認すること）:
- 文体が「ですます調」か（必須）
- 絵文字が含まれていないか（必須）
- 各セクションが過度に長くないか（各段落は短く簡潔に）
- 主要ドキュメントへの相対リンクが正しいか
例: 生成結果の抜粋（簡潔なサンプル）:
lang-chain-study
軽量なエージェントとフロントエンドを含む学習用リポジトリです。主に対話型デベートエージェントの実装とフロントエンドでのデバッグを目的としています。
クイックスタート
前提: Python 3.11
インストール:
pip install -r requirements.txt
起動:
python -m ai_debate_agent.api
主要ドキュメントは以下を参照してください。
./.kiro/specs/debate-export/tasks.md— デベートエクスポート仕様./frontend/— フロントエンド実装
注意事項:
- 既存の README を更新する場合は、変更点の要約を最初に提示して承認を得てから適用してください。
---
このスキルは、プロジェクトのトップ README を迅速に整備するためのガイドラインとテンプレートを提供します。README を自動生成する場合は、生成結果を必ず確認してからコミットしてください。