コードベーススナップショットマッパー(リポジトリスキャン → モジュールマップ → 30分オンボーディングブリーフ)
任意のGitHubリポジトリを、エントリーポイント、モジュール、主要依存関係、学習優先事項を含む1ページのアーキテクチャマップに素早く変換し、迅速なオンボーディングを実現します。
プロンプト概要
あなたへのヒント
- VS Codeのパスコピー機能でトリムしたファイルツリーを貼り付けてください。 - package.jsonやpyproject.tomlを含めてスクリプトやツールを推測しましょう。 - エントリーフローの精度向上のために、サンプルのエンドポイントやコマンドを1つ追加してください。
運用チームよりNexusAi Technology解決する課題
新しい貢献者は、実行開始箇所やモジュールの関係、重要なファイルを把握するのに多くの時間を費やします。このプロンプトは明確なマップとスターターブリーフを作成し、自信を持ってナビゲートできるようにします。
迅速なエントリーポイント検出
アプリの起動方法と実行開始箇所を特定します。
モジュール責任マップ
主要フォルダとその役割を1ページで要約します。
依存関係の洞察
重要なライブラリとその重要性を明らかにします。
時間制限付きオンボーディングプラン
30分間の5ステップスタータープランを提供します。
AIプロンプト指示
経験豊富なソフトウェアアーキテクト兼オンボーディングメンターとして振る舞ってください。
このタスクが重要な理由:
新しい貢献者はエントリーポイント、コアモジュール、慣習を探すのに時間を浪費します。明確なスナップショットは初回コミットまでの時間を短縮し、ミスを減らします。
重要な制約:
- コードをでっち上げず、提供されたツリー、README、選択されたファイルに基づいて洞察を行ってください。
- 不確実な点は明示し、証拠が不十分な場合は次に調査すべきファイルをリストアップしてください。
ユーザー入力:
- リポジトリ名、目的、主要言語/フレームワーク。
- 重要ファイル:README、package/lockファイル、メインアプリ/サーバーのエントリ、ルーティング設定、モジュールフォルダ、テスト。
- 高レベルの目標(例:オンボーディング、バグトリアージ、機能追加)。
目的:
1) 主なエントリーポイントと実行フローを特定する。
2) 主要モジュール、役割、データフローを概説する。
3) 依存関係、設定、スクリプト、共通ユーティリティを強調する。
4) 複雑性のホットスポットと即時学習優先事項を示す。
分析ワークフロー:
1) READMEを解析し、プロジェクトの目標、セットアップ、実行コマンドを把握する。
2) 依存ファイルを調査し、ビルド、実行、テストパイプラインを推測する。
3) エントリーポイント(例:main.ts、index.js、app.py)とルーティングをマッピングする。
4) ファイルを機能別にグループ化し、それぞれを一文で要約する。
5) 横断的関心事(認証、ログ、エラーハンドリング、状態管理)を記録する。
6) 読むべき上位5つのファイル/フォルダを特定する。
必要な出力形式:
- 1段落の概要。
- アーキテクチャマップ:モジュール → 役割 → 主要ファイルの箇条書き。
- エントリーポイントとリクエスト/CLIフローの概要。
- 主要依存関係とその重要性。
- 複雑性のホットスポットとリスク注記。
- 30分オンボーディングプラン(5ステップ、時間制限あり)。
品質管理:
- 正確なファイル名とパスを使用する。
- 事実と推測を分け、推測は明確にマークする。
検証チェックリスト:
- エントリーポイントが特定されている。
- 少なくとも5つのモジュールまたはフォルダがマッピングされている。
- 実行/テストコマンドが把握されている。
- 学習優先事項がランク付けされている。
最終指示:
新しい開発者の最初の30分に適した、簡潔で読みやすい1ページのブリーフを作成してください。
期待される成果
概要:Node.js + Expressを使用したタスク管理用Web API。 アーキテクチャマップ: - server/: Expressアプリのブートストラップ(server/index.js) - routes/: HTTPエンドポイント(routes/tasks.js) - controllers/: リクエストのオーケストレーション(controllers/taskController.js) - models/: Sequelizeを使ったデータアクセス(models/task.js) - middleware/: 認証・ログ処理(middleware/auth.js) エントリーフロー:npm run start → server/index.js → routes → controllers → models。 主要依存関係:express、sequelize、jsonwebtoken。 ホットスポット:認証ミドルウェアの複雑さ、tasksコントローラーの規模。 30分プラン:1) READMEをざっと読む(3分) 2) server/index.jsを開く(5分) 3) GET /tasksの処理を追う(7分) 4) 認証ミドルウェアを確認(7分) 5) テストを実行(8分)。
実装ステップ
ChatGPTでスナップショットを生成する
ChatGPTを開きます。リポジトリのREADME、トリムしたファイルツリー、重要なファイル(エントリーポイント、ルーティング、設定)を貼り付けて、このプロンプトを使い1ページのアーキテクチャマップと30分オンボーディングプランを依頼してください。モジュールリスト、エントリーフロー、学習優先事項が得られます。
10 minVS Codeでリポジトリと照合して確認する
VS Codeでリポジトリを開き、リストアップされた各ファイルやパスにジャンプして役割を確認します。構造が異なる場合はモジュール名を調整してください。記載された開始・テストスクリプトを実行し、エントリーポイントとテストカバレッジを検証します。
10 minチームのオンボーディングノートとして公開する
スナップショット、ファイルへのリンク、30分プランを含む短いドキュメントをナレッジベースやリポジトリのWikiに作成します。新しい貢献者のためにリポジトリのREADMEにピン留めしてください。
10 min
