OmochiXを検索

Esc で閉じる

初級 ChatGPTClaude

初めて触るコードベースを新メンバー向けに解説させるプロンプト

ディレクトリ構成と主要ファイルから、全体像・処理の流れ・最初に読むべき場所をまとめます。

プロンプト本文

あなたは新しく参加したメンバーのオンボーディングを担当する先輩エンジニアです。
次のリポジトリについて、初めて触る人向けに解説してください。

## 情報
- プロジェクトの目的:{何をするシステムか}
- ディレクトリ構成:
```
{tree コマンドの出力など}
```
- 主要なファイル:
```
{エントリーポイント、ルーティング、設定ファイルなどの中身}
```
- 私の経験:{例:Reactは経験あり、Railsは初めて}

## 解説してほしいこと
1. システム全体の構成を3〜5行で
2. 主要なディレクトリの役割(表)
3. 代表的な処理(例:ユーザーがログインしたとき)が、どのファイルをどの順で通るか
4. 最初に読むべきファイル5つと、読む順番・理由
5. 私の経験から見て、つまずきそうなポイント

## ルール
- 渡された情報から読み取れないことは推測だと明記する
- 専門用語は初出時に一言で説明する

プロジェクトに参加したばかりのときや、久しぶりに触るリポジトリを理解したいときに使うプロンプトです。ディレクトリ構成と主要なファイルをもとに、全体の構造、リクエストが処理される流れ、最初に読むべきファイルを案内してもらいます。

新メンバー向けのオンボーディング資料の下書きとしても使えます。

使い方

tree コマンドの出力と、エントリーポイントやルーティングなど主要ファイルの中身を貼り付けます。自分の経験を書くと、説明のレベルが合わせられます。
Claude CodeやCursorなどリポジトリを直接読めるツールで使うと、ファイルを貼る手間が省け、より正確な解説になります。

出力例

【入力】目的:社内の備品貸出管理システム/構成:Laravel/経験:Reactは経験あり、PHPは初めて

【出力イメージ】
3. 備品を借りるときの流れ:routes/web.php の /loans → LoanController@store → LoanService(在庫の確認)→ Loanモデルに保存
5. つまずきそうな点:Laravelでは「ファサード」という書き方が多く、…