[実践ガイド] Cursor を使って未知のコードベースを効率的に理解する方法: 構造化されたワークフローと、さまざまなモードとモデルを切り替えて複雑なコードベースをわかりやすいドキュメントに分解する 主な目的は、AI を活用して、新しいプロジェクトのコード アーキテクチャ、テクノロジ スタック、ビジネス ロジックを迅速かつ深く理解し、繰り返し参照できるドキュメントを生成することです。 詳細なワークフロー分析では、コードを理解するプロセスを 7 つの明確なステップに分割します。要約すると次のようになります。 1. セキュリティ調査とグローバルスキャン(準備フェーズ) 「質問モード」を有効にする: • 操作: カーソルを質問モードに切り替えます。 目的: これは、探索中に誤ってコードが変更されるのを防ぎ、コードベースのセキュリティを確保するための読み取り専用モードです。 クイック検索: • 操作: より高速なモデル Composer 1 を選択し、コードベース全体と主要なサブフォルダーをスキャン (grep) します。 • 目的: AI が迅速なスキャンを通じてプロジェクトの予備的なマクロレベルの理解を得られるよう支援します。 2. 学習計画を作成する(計画段階) 理解計画を作成します。 • 操作: プランモードに切り替えます。 • 指示: AI に「コードベースを理解する方法」に関する計画を作成するように要求します。 • コンテンツの焦点: テクノロジーの統合 (Resend や AI SDK などのサードパーティ ライブラリなど) から始めて、徐々にファイル ディレクトリ構造に移行します。 • 目的: コードを盲目的に読むのではなく、AI を活用して論理的に明確な学習パスを計画します。 3. 自動ドキュメント生成(実行フェーズ) 深度インデックスと分解: • 操作: 前のステップの計画を Markdown ファイルとして保存し、エージェント モードに切り替えて、強力なモデルを選択します。 • コマンド: エージェントにデータベース全体のインデックスを作成し、コードベースを複数の Markdown ドキュメントに分割するよう指示します。 ドキュメントカテゴリ: • フロントエンド(フロントエンドアーキテクチャ) • バックエンド(バックエンドアーキテクチャ) • ユーザージャーニー(ビジネスプロセス) • 技術的な詳細 4. 視覚支援(上級段階) 複雑なアーキテクチャ図: • シナリオ: プロジェクトに Redis やマイクロサービスなどの複雑なコンポーネントが含まれている場合、単純なテキストによる説明では直感的ではありません。 • アクション: Claude モデルに戻ります。 • 目的: Claude の強力なコンテキスト理解機能を活用して、製品ワークフローのアーキテクチャ図やフローチャートを生成し、視覚的な理解を支援します。 5. レビューと反復(内部化フェーズ) 読書と質疑応答: • 操作: 生成されたドキュメントを読むには、プレビュー モードに切り替えます。 • ループ: 理解できない詳細に遭遇した場合は、質問モードに戻って AI に助けを求めることができます。 • 繰り返し: 基本的な認知フレームワークが確立されるまで、このプロセスを複数回繰り返します。 💡 重要なポイント:「悪いペンは良い記憶よりも悪い」— プロセス全体を通して受動的に読むだけではいけません。以下の2つのメモを取る習慣を身につけることを重視しましょう。 • エンジニアリング実装ノート: 特定の機能がどのように実装されるかのロジックの簡単な記録。 • 主要ファイル名: コアワークフローに関係する重要なファイルの名前を記録して、後で簡単に見つけられるようにします。 このアプローチの本質は、「分割統治」と「読むのではなく書く」にあります。コードの海に突っ込むのではなく、まずAIの計画機能を使って計画を生成し、次にAIの実行機能を使って指示を生成し、最後にターゲットを絞ったダイアグラムを通して難問に取り組みます。
スレッドを読み込み中
X から元のツイートを取得し、読みやすいビューを準備しています。
通常は数秒で完了しますので、お待ちください。
![[実践ガイド] Cursor を使って未知のコードベースを効率的に理解する方法: 構造化されたワークフローと、さまざまなモードとモデルを切り替えて複雑なコードベースをわかりやすいドキュメントに分解する
主な目的は、AI を活用して、新しい](https://pbs.twimg.com/media/G7aL_o8aAAAqkNa.jpg)