configure-readme

このスキルを使用するタイミング

次の場合はこのスキルを使用します…	次の場合は別の方法を使用します…
新しいプロジェクトの README.md をゼロから作成する	README の特定の箇所を編集する — ファイルを直接編集します
既存の README に不足しているセクション（バッジ、インストール方法、構成）がないか監査する	詳細な API ドキュメントを作成する — /configure:docs を使用します
複数のプロジェクトで README の形式を標準化する	GitHub Pages のドキュメントサイトを作成する — /configure:github-pages を使用します
shields.io バッジ、技術スタックの表、またはプロジェクト構成のセクションを追加する	変更履歴を作成する — conventional commits を使用した release-please の自動化を利用します
検出されたスタックに合ったインストール／ビルド／テストコマンドが README に記載されていることを確認する	1 つのセクションだけを更新する — ファイルを直接編集します

コンテキスト

• プロジェクトルート: !pwd
• プロジェクト名: !basename $(pwd)
• README の有無: !find . -maxdepth 1 -name 'README.md'
• パッケージファイル: !find . -maxdepth 1 \( -name 'package.json' -o -name 'pyproject.toml' -o -name 'Cargo.toml' -o -name 'go.mod' \)
• Git リモート: !git remote -v
• ライセンスファイル: !find . -maxdepth 1 -name 'LICENSE*'
• アセットディレクトリ: !find . -maxdepth 2 -type d \( -name 'assets' -o -name 'public' -o -name 'images' \)
• ロゴファイル: !find . -maxdepth 3 -type f \( -name 'logo*' -o -name 'icon*' \)

パラメーター

コマンド引数から解析します。

• --check-only: 変更を加えずに README の準拠状況を報告します（CI/CD モード）
• --fix: 確認を求めずに修正を自動適用します
• --style <minimal|standard|detailed>: README の詳細レベル（既定値: standard）
• --badges <shields|custom>: バッジのスタイル設定（既定値: shields）
• --no-logo: アセットが存在する場合でもロゴのセクションを省略します

スタイルレベル:

• minimal: タイトル、説明、バッジ、基本的なインストール方法／使用方法
• standard: minimal に加えて、ロゴ、機能、技術スタック、利用開始方法、ライセンスを含みます（推奨）
• detailed: standard のすべてに加えて、アーキテクチャ図、API リファレンス、コントリビューションガイド、変更履歴へのリンクを含みます

実行

次の README 構成ワークフローを実行します。

ステップ 1: プロジェクトのメタデータを検出する

検出されたパッケージファイルからプロジェクトのメタデータを読み取ります。

1. package.json（JavaScript/TypeScript）: name、description、version、license、repository、keywords を抽出します
2. pyproject.toml（Python）: project name、description、version、license、keywords、URLs を抽出します
3. Cargo.toml（Rust）: package name、description、version、license、repository、keywords を抽出します
4. go.mod（Go）: owner/repo 用のモジュールパスを抽出します

一致するパッケージファイルがない場合のフォールバック検出:

• プロジェクト名: ディレクトリ名
• 説明: 既存の README の先頭行、またはユーザーに確認します
• リポジトリ: git remote の URL
• ライセンス: LICENSE ファイルの内容

パッケージファイル形式の詳細な例については、REFERENCE.md を参照してください。

ステップ 2: 現在の README の状態を分析する

既存の README.md に次のセクションがあるか確認します。

• ロゴ／アイコンがある（先頭に中央揃えの画像）
• プロジェクトタイトル（h1）
• 説明／タグライン
• バッジの行（ライセンス、バージョン、CI ステータス、カバレッジ）
• 機能のセクション
• 技術スタックのセクション
• 前提条件のセクション
• インストール手順
• 使用例
• プロジェクト構成
• コントリビューションガイドライン
• ライセンスのセクション

一般的な場所からロゴ／アイコンのアセットを探します。

• assets/logo.png、assets/icon.png、assets/logo.svg
• public/logo.png、public/icon.svg
• images/logo.png、docs/assets/logo.png
• .github/logo.png、.github/images/logo.png

ステップ 3: 準拠レポートを生成する

README の各セクションについて、PASS／MISSING／PARTIAL のステータスを示すセクション別の準拠レポートを出力します。コンテンツの品質チェック（コード例、コマンドの正確性、リンクの有効性）も含めます。

--check-only が設定されている場合は、ここで終了します。

準拠レポートの形式については、REFERENCE.md を参照してください。

ステップ 4：設定を適用する（--fix が指定された場合、またはユーザーが確認した場合）

標準テンプレートの構成に従って README.md を生成します。

1. ロゴを中央揃えで表示するセクション（アセットがあり、--no-logo が設定されていない場合）
2. プロジェクトのタイトルとタグライン
3. shields.io の URL を使用したバッジ行
4. 主な特長をまとめた機能セクション
5. 技術スタックの表
6. はじめに（前提条件、インストール、使い方）
7. プロジェクト構成
8. 開発コマンド
9. コントリビューションのセクション
10. ライセンスのセクション

README テンプレート全体とバッジ URL のパターンについては、REFERENCE.md を参照してください。

ステップ 5：ロゴとアセットを扱う

ロゴがなく、ユーザーがロゴを希望する場合：

1. 一般的な場所に既存のアセットがあるか確認します
2. シンプルなテキストベースのプレースホルダーを作成するか、絵文字付きの見出しを使うよう提案します
3. 必要に応じてアセット用ディレクトリを作成します：mkdir -p assets
4. ツールとして、カスタムバッジには Shields.io、技術アイコンには Simple Icons を提案します

ステップ 6：プロジェクトのコマンドを検出する

パッケージマネージャー／ビルドツールに基づいて、プロジェクトのコマンドを自動検出します。

パッケージマネージャー	インストール	実行	テスト	ビルド
npm/bun (package.json)	package.json の scripts を読み取る	npm run dev	npm test	npm run build
uv/poetry (pyproject.toml)	uv sync / poetry install	uv run python -m pkg	uv run pytest	-
cargo (Cargo.toml)	cargo build	cargo run	cargo test	cargo build --release
go (go.mod)	go build	go run .	go test ./...	go build

ステップ 7：プロジェクト構成を生成する

tree -L 2 -I 'node_modules|target|__pycache__|.git|dist|build' --dirsfirst を実行して、正確なプロジェクト構成を生成します。一般的な生成ディレクトリ（node_modules、vendor、target、dist、build、pycache、.pytest_cache、.git、.venv、venv）は省略します。

ステップ 8：標準規約のトラッキングを更新する

.project-standards.yaml を更新します：

components:
  readme: "2025.1"
  readme_style: "[minimal|standard|detailed]"
  readme_has_logo: true|false
  readme_badges: ["license", "stars", "ci", "version"]

ステップ 9：生成した README を検証する

README を生成した後、次の項目を検証します。

1. Markdown の構文エラーがないか確認します
2. すべてのリンクにアクセスできることを確認します（警告のみ）
3. shields.io の URL が正しい形式であることを確認します
4. ロゴ／画像のパスが存在することを確認します

ステップ 10：設定結果を報告する

行った変更、README の場所、推奨される次の手順（機能の説明のカスタマイズ、ロゴの追加、ほかの configure コマンドの実行）をまとめて表示します。

結果レポートの形式については、REFERENCE.md を参照してください。

--style detailed が指定された場合は、Mermaid 図を含むアーキテクチャセクション、API リファレンスへのリンク、変更履歴へのリンクも追加します。詳細スタイルのテンプレートについては、REFERENCE.md を参照してください。

出力

次の項目を提示します。

1. セクションごとのステータスを含む準拠レポート
2. 生成または更新された README.md の内容
3. 検出されたプロジェクトメタデータの一覧
4. 改善の提案（ロゴ、機能の追加など）

エージェント向けの最適化

コンテキスト	コマンド
簡易的な準拠チェック	/configure:readme --check-only
すべての問題を自動修正	/configure:readme --fix
最小限の README	/configure:readme --fix --style minimal
詳細な README	/configure:readme --fix --style detailed
プロジェクトツリーを生成	tree -L 2 -I 'node_modules|target|__pycache__|.git|dist|build' --dirsfirst
README が存在するか確認	test -f README.md && echo "EXISTS" || echo "MISSING"

関連項目

• /configure:docs - コードドキュメントの標準規約を設定
• /configure:github-pages - ドキュメントのホスティングを設定
• /configure:all - すべての準拠チェックを実行
• REFERENCE.md - README テンプレート、バッジのリファレンス、セクションの標準規約、準拠チェックリスト