Skip to content

リポジトリ品質確認プロンプト V3

リポジトリ全体の品質確認をチェックリスト形式で行うためのプロンプトです。V3では日英バイリンガル対応(README.mdとREADME_JP.md)に対応しています。

想定用途

  • リポジトリ全体の品質確認
  • README.mdの品質チェック(日英バイリンガル対応)
  • ドキュメント一貫性の確認
  • 環境設定とセキュリティの確認
  • コード品質のチェック
  • プロジェクト構造の評価

プロンプト本文

text
# リポジトリ品質確認プロンプト V3

あなたは優れたコードレビューとリポジトリ構造分析の専門家です。以下のチェックリストに沿って、リポジトリ全体の品質確認を行ってください。各項目について「✅」(問題なし)、「❌」(問題あり)、「⚠️」(一部問題あり)のいずれかで評価し、問題がある場合は具体的な改善提案を提示してください。

## チェックリスト

### 📝 README.md の品質確認
- [ ] タイトルは中央揃えになっているか (`<h1 align="center">タイトル</h1>` または `<p align="center"># タイトル</p>` の形式)
- [ ] ヘッダー画像は中央揃えになっているか(既にヘッダー画像がある場合はそれを使用すること)
- [ ] 技術スタックのバッジが適切に配置され、中央揃えになっているか
- [ ] 言語切り替えバッジ(日本語・英語)が中央揃えで配置されているか
- [ ] 各セクションに絵文字が活用され、可読性が向上しているか
- [ ] インストール手順が簡潔かつ明確に記載されているか
- [ ] 使用方法が簡潔かつ明確に記載されているか
- [ ] 必要に応じてスクリーンショットや図が使用されているか

### 📚 ドキュメンテーション全体の一貫性
- [ ] 各階層に README.md(英語)と README_JP.md(日本語)が存在するか(なければ作成が必要)
- [ ] 各階層の README のタイトルも中央揃えになっているか
- [ ] 各階層の README に言語切り替えバッジ(日本語・英語)が中央揃えで配置されているか
- [ ] 各階層の README が上位階層の README を適切に参照し、重複を避けているか
- [ ] README の内容が簡素化され、可能な限りコードを参照する形になっているか
- [ ] 冗長な章や表現が避けられているか
- [ ] 全てのドキュメントで一貫した用語が使用されているか

### 🔒 環境設定とセキュリティ
- [ ] `.env` や環境変数が適切に使用されているか
- [ ] 直接コード内にAPIキーやパスワードなどの機密情報が記載されていないか(`.env`は除く)
- [ ] `.gitignore` ファイルに `.env` が適切に記載されているか
- [ ] `.env.example` が存在し、必要な環境変数の例が記載されているか

### 💻 コード品質
- [ ] コードコメントは必要最小限かつ適切に記載されているか
- [ ] 命名規則が一貫しているか
- [ ] 未使用のコードやコメントアウトされたコードが放置されていないか

### 📂 プロジェクト構造
- [ ] フォルダ構造が論理的で理解しやすいか
- [ ] 依存関係が適切に管理されているか

## 出力形式

以下のような形式でチェックリストの結果を出力してください:

### 📝 README.md の品質確認
- [✅/❌/⚠️] タイトルは中央揃えになっているか
  - 問題点と改善提案(問題がある場合)
- [✅/❌/⚠️] ヘッダー画像は中央揃えになっているか
  - 問題点と改善提案(問題がある場合)
- ...(以下同様)

### 📚 ドキュメンテーション全体の一貫性
- [✅/❌/⚠️] 各階層に README.md(英語)と README_JP.md(日本語)が存在するか
  - 問題点と改善提案(問題がある場合)
- [✅/❌/⚠️] 各階層の README のタイトルも中央揃えになっているか
  - 問題点と改善提案(問題がある場合)
- ...(以下同様)

(他のセクションも同様の形式で)

### 🔍 総評
リポジトリの現在の状態に関する簡潔な総評と、優先して対応すべき最重要の改善点3つを提示してください。

### 📝 具体的な修正例
最も重要な改善点について、具体的なコードやマークダウンの修正例を提示してください。

#### README.md 階層構造確認
以下の点を特に注意して確認してください:
1. 各ディレクトリに README.md(英語)と README_JP.md(日本語)があるか確認し、なければ作成を提案する
2. 各 README が言語切り替えバッジを含み、タイトルが中央揃えになっているか確認する
3. 各 README の内容が簡素化され、冗長な情報を含まないようになっているか確認する
4. 各 README が上位の README を適切に参照しているか確認し、重複を避ける

#### 言語切り替えバッジの標準フォーマット
各 README には以下のような言語切り替えバッジを中央揃えで配置してください:

```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>

このチェックリストに沿って、リポジトリ全体を分析し、開発サイクルのクロージング処理として必要な改善点を明確にしてください。


## 使い方

1. プロンプトをAIに貼り付け
2. チェックしたいリポジトリの情報を提供
3. チェックリストに沿った評価を受け取る

## 入力例

リポジトリのURLまたはファイル構造を提供するだけで、チェックリストに沿った評価が行われます。

## 出力例

各チェック項目の評価結果(✅/❌/⚠️)と、問題がある場合は具体的な改善提案が提供されます。

## V2との違い

- 日英バイリンガル対応(README.mdとREADME_JP.md)
- 言語切り替えバッジの標準フォーマット追加
- ドキュメントの簡素化と重複排除の強調

## 注意点

- README.mdの階層構造に特に注意して確認してください
- 日英両方のREADMEが存在するか確認してください
- 言語切り替えバッジが正しく配置されているか確認してください