ドキュメントレビュー

目的

指定されたドキュメントの品質と一貫性をチェックリストに沿って評価し、問題点と具体的な改善提案を提示する。可能な範囲で自動修正を行い、変更内容を明示する。

ワークフロー

1. •対象ドキュメントを読み取り、対象範囲（単一READMEか、英日両方か）を確認する。
2. •チェックリストに沿って各項目を評価し、結果を [✅/❌/⚠️] で示す。
3. •問題がある項目のみ、原因と改善提案を簡潔に書く。
4. •重要度の高い改善点について、具体的な修正例（Markdown/HTML）を提示する。
5. •自動修正できる項目はその場で修正し、変更ファイルと内容を報告する。
6. •英語版ドキュメントが存在しない場合は、作成前に必ずユーザーへ確認する。

チェックリスト

📝 ドキュメントの品質確認

• •タイトルは中央揃えになっているか（<h1 align="center">タイトル</h1> または <p align="center"># タイトル</p>）
• •ヘッダー画像は中央揃えになっているか（既存画像があればそれを使用）
• •技術スタックのバッジが適切に配置され、中央揃えか
• •言語切り替えバッジ（日本語・英語）が中央揃えで配置されているか
• •各セクションに絵文字が活用され、可読性が向上しているか
• •インストール手順が簡潔かつ明確に記載されているか
• •使用方法が簡潔かつ明確に記載されているか
• •必要に応じてスクリーンショットや図が使用されているか

📚 ドキュメンテーション全体の一貫性

• •ドキュメント（英語）とドキュメント（日本語）が存在するか（なければ作成が必要）
• •ドキュメントのタイトルも中央揃えになっているか
• •ドキュメントに言語切り替えバッジ（日本語・英語）が中央揃えで配置されているか
• •ドキュメントの内容が簡素化され、可能な限りコードを参照する形になっているか
• •冗長な章や表現が避けられているか
• •全てのドキュメントで一貫した用語が使用されているか

出力フォーマット

次のテンプレートを厳守する。

📝 ドキュメントの品質確認

• •[✅/❌/⚠️] タイトルは中央揃えになっているか
  • •問題点と改善提案（問題がある場合のみ）
• •[✅/❌/⚠️] ヘッダー画像は中央揃えになっているか
  • •問題点と改善提案（問題がある場合のみ）
• •...（以下同様）

📚 ドキュメンテーション全体の一貫性

• •[✅/❌/⚠️] ドキュメント（英語）とドキュメント（日本語）が存在するか
  • •問題点と改善提案（問題がある場合のみ）
• •[✅/❌/⚠️] ドキュメントのタイトルも中央揃えになっているか
  • •問題点と改善提案（問題がある場合のみ）
• •...（以下同様）

📝 具体的な修正例

重要な改善点について、具体的なコード/Markdownの修正例を提示する。

言語切り替えバッジの標準フォーマット

<p align="center">
  <a href="README_JP.md"><img src="https://img.shields.io/badge/ドキュメント-日本語-white.svg" alt="JA doc"/></a>
  <a href="README.md"><img src="https://img.shields.io/badge/english-document-white.svg" alt="EN doc"></a>
</p>

🛠️ 自動修正内容

• •変更ファイルと内容を簡潔に列挙する。
• •ユーザに指摘事項を修正するか確認する
• •確認が取れたら修正を行う

注意点

• •根拠のない断定は避ける。情報不足の場合は「確認が必要」と明示する。
• •指摘は簡潔に、改善提案は具体的に書く。
• •英語版の作成は必ずユーザーへ確認してから行う。
• •出力は日本語で行う（ユーザーが別言語を指定した場合はそれに従う）。