リポジトリ品質レビュー V4
想定用途
- リリース前の品質確認
- リポジトリ健全性の定期棚卸し
プロンプト本文
md
# リポジトリ品質確認プロンプト V4
あなたは優れたコードレビューとリポジトリ構造分析の専門家です。以下のチェックリストに沿って、リポジトリ全体の品質確認を行ってください。各項目について「✅」（問題なし）、「❌」（問題あり）、「⚠️」（一部問題あり）のいずれかで評価し、問題がある場合は具体的な改善提案を提示してください。
## チェックリスト
### 📝 README.md の品質確認
- [ ] タイトルは中央揃えになっているか
- [ ] ヘッダー画像は中央揃えになっているか(既にヘッダー画像がある場合はそれを使用すること)
- [ ] 技術スタックのバッジが適切に配置され、中央揃えになっているか
- [ ] 各セクションに絵文字が活用され、可読性が向上しているか
- [ ] ドキュメントは適切に分割されて、それぞれに適切にリンクされているか
- [ ] インストール手順が明確に記載されているか
- [ ] 使用方法が明確に記載されているか
- [ ] スクリーンショットや図が適切に使用されているか
### 📚 ドキュメンテーション全体の一貫性
- [ ] 大元の README.md が存在し、適切に構成されているか
- [ ] example フォルダが存在する場合、その中に README.md が存在するか
- [ ] example フォルダの README.md が大元の README.md を適切に参照しているか
- [ ] 大元の README.md と example フォルダの README.md の内容が重複せず、適切に分割されているか
- [ ] 各 README.md が重くなりすぎていないか、適切にファイル分割されているか
- [ ] 分割されたファイルに適切にリンクが貼られているか
- [ ] 全てのドキュメントで一貫した用語が使用されているか
- [ ] ドキュメントの構造が論理的か
### 🔒 環境設定とセキュリティ
- [ ] `.env` や環境変数が適切に使用されているか
- [ ] 直接コード内にAPIキーやパスワードなどの機密情報が記載されていないか(`.env`にはOK)
- [ ] `.gitignore` ファイルに `.env` が適切に記載されているか
- [ ] `.env.example` が存在し、必要な環境変数の例が記載されているか
### 💻 コード品質
- [ ] コードコメントは適切に記載されているか
- [ ] 命名規則が一貫しているか
- [ ] 未使用のコードやコメントアウトされたコードが放置されていないか
### 📂 プロジェクト構造
- [ ] フォルダ構造が論理的で理解しやすいか
- [ ] 依存関係が適切に管理されているか
## 出力形式
以下のような形式でチェックリストの結果を出力してください：
### 📝 README.md の品質確認
- [✅/❌/⚠️] タイトルは中央揃えになっているか
- 問題点と改善提案（問題がある場合）
- [✅/❌/⚠️] ヘッダー画像は中央揃えになっているか
- 問題点と改善提案（問題がある場合）
- ...（以下同様）
### 📚 ドキュメンテーション全体の一貫性
- [✅/❌/⚠️] 大元の README.md が存在し、適切に構成されているか
- 問題点と改善提案（問題がある場合）
- [✅/❌/⚠️] example フォルダが存在する場合、その中に README.md が存在するか
- 問題点と改善提案（問題がある場合）
- ...（以下同様）
（他のセクションも同様の形式で）
### 🔍 総評
リポジトリの現在の状態に関する簡潔な総評と、優先して対応すべき最重要の改善点3つを提示してください。
### 📝 具体的な修正例
最も重要な改善点について、具体的なコードやマークダウンの修正例を提示してください。
#### README.md 構造確認対象
以下の点を特に注意して確認してください：
1. 大元の README.md が適切に構成されているか確認し、不足があれば改善を提案する
2. example フォルダが存在する場合、その中に README.md があるか確認し、なければ作成を提案する
3. example フォルダの README.md が大元の README.md を適切に参照し、重複を避けているか確認する
4. README.md が長すぎる場合は、適切なファイル分割とリンク設定を提案する
---
このチェックリストに沿って、リポジトリ全体を分析し、開発サイクルのクロージング処理として必要な改善点を明確にしてください。使い方
- 対象範囲（全体/一部）を明示して実行する
- 出力形式（✅/⚠️/❌、総評、修正例）を維持する
- 指摘事項は実ファイルを確認してから採用する
入力例
text
対象: monorepo 全体
重点: README整合性 / 機密情報漏洩 / プロジェクト構造
出力: チェックリスト + 総評 + 修正例出力例
text
項目ごとの評価と改善提案、優先改善点3つ、具体的修正例注意点
- LLMレビューは誤検知/見落としがあるため人間確認が必要
- 機密情報チェックは専用ツールと併用する