メインコンテンツへスキップ

引き継いだコードを読み解く

  • レッスン 27
  • 10分

このレッスンで

終わる頃には、次ができるようになります

  • 前任者から引き継いだコードベースを、ファイルを変更しないPlanモードで読ませ、構成の地図と主な処理の流れを説明させることができる
  • 危なそうな箇所と最初に読むべきファイルを挙げさせ、そこから引き継ぎ資料の下書きとテストの有無の確認を続けて頼むことができる
  • 秘密情報を含むファイルを読ませる前に確かめ、返ってきた説明は実際のコードを開いて検証してから使うことができる

前任者が書いたコードを、ある日そのまま引き継ぐことがあります。ファイルはたくさんあるのに、どこから手を付ければいいのか分からず、コメントもほとんど残っていない。

エンジニアでなくても、担当替えや退職に伴う引き継ぎで、こういう状況に立つことは珍しくありません。触って壊すのが怖くて、結局いちばん大事な部分には手を付けないまま、なんとなく運用だけ続けている。そんなときの頼み方です。

使う機能

Claude Code(ターミナルまたはデスクトップアプリ)の読むだけの依頼と、ファイルを変更しないPlanモード

用意するもの

引き継いだコード一式が入ったフォルダ(あらかじめPC上にまとめておく)

やってみる時間の目安

全体像の説明が出るまで10分程度

このレシピで使うもの

1. 頼み方

引き継いだコードが入ったフォルダで、Claude Codeを開きます。まずShift+Tabを押すか、依頼の先頭に/planと付けて、Planモードに切り替えてください。Planモードは、Claudeがファイルを読んで計画を書くだけで、承認するまでソースコードそのものは変更しないモードです。

切り替えたら、次のプロンプトを送ります。〔 〕の中は自分の場面に置き換えます。

自分の仕事に置き換えるテンプレート
このフォルダ全体を読んで、次の4点を教えてください。この時点では
ファイルを一切変更しないでください。

1. 構成の地図:主なフォルダとファイルが、それぞれ何の役割か
2. 主な処理の流れ:〔中心となる機能、例:注文を受け付ける処理〕が、
   どのファイルからどのファイルへ流れて動いているか
3. 危なそうな箇所:壊れやすい、前提が特殊、コメントが無いまま
   複雑になっている、といった注意が必要な箇所
4. 最初に読むべきファイル:全体を理解するなら、どのファイルから
   読み始めるのが近道か

Planモードのままなら、この依頼だけで書き換えが起きる心配はありません。

2. 渡すもの

渡すのは、ファイルの添付ではありません。Claude Codeを起動した場所(ターミナルならcdで移動したフォルダ、デスクトップアプリなら選んだプロジェクトフォルダ)が、そのまま読む対象になります。引き継いだコード一式を、あらかじめ専用のフォルダにまとめておいてください。

注意

秘密情報のファイルは、読ませる前に確かめる

フォルダの中に.env、credentials.json、鍵ファイルなど、パスワードやAPIキーが書かれたファイルが混ざっていないか、先に確認してください。含まれている場合は、その読み込み自体を権限設定で拒否できます。Claude Codeの権限ルールには、Read(./.env)のように特定のファイルの読み込みを名指しで拒否する書き方があります。

3. 返ってくるもの

出力は、1節で挙げた4項目に沿った説明として返ってきます。以下は架空の例です。実際のコードではありません。

  • 構成の地図: 「注文」「在庫」「通知」の3つのフォルダに分かれている。共通処理はutilsに集約されている
  • 主な処理の流れ: 注文フォームの入力をorder/form.jsが受け取り、order/validate.jsで検証したあとinventory/check.jsに渡している
  • 危なそうな箇所: inventory/check.jsには在庫が0になったときの処理にコメントが無く、対応するテストも見当たらない
  • 最初に読むファイル: 全体の呼び出し関係を把握するならorder/index.jsから読み始めるのが近道

この説明は、Claudeがコードを読んで推測した内容です。 特に「危なそうな箇所」の指摘は、実際に該当ファイルを開いて自分の目で確かめてから、次の判断に使ってください。

4. 続けて頼むこと

全体像が分かったら、同じ会話のまま続けて2つのことを頼めます。

同じチャットに続けて送る
ここまでの説明をもとに、次にこのコードを引き継ぐ人が読む引き継ぎ書を
作って。全体の構成、主な処理の流れ、触るときに注意すべき箇所の3つを
中心にまとめて。Markdownファイル(引き継ぎ書.md)として出力して。
この時点でもまだコードは変更しないで。
同じチャットに続けて送る
このコードにテストがあるか確認して。ある場合は、どこにあり、どう
実行するか教えて。無い場合は、まず何にテストを足すのが優先度が
高いか、理由と合わせて3つ挙げて。テストはまだ書かないで。

引き継ぎ書は、そのまま配るのではなく、実際にコードを操作しながら自分で1行ずつ読み合わせてください。テストの有無が分かったら、その結果をもとに次の一手を決めます。

5. うまくいかないとき

いきなり書き換えさせない

最初の依頼は、Planモードのまま、または「まだ変更しないで」と明示したうえで送ってください。全体像も分からないうちに書き換えが混ざると、何が元の状態だったのか分からなくなります。

秘密情報のファイルは、読ませる前に確かめる

引き継いだフォルダには、前任者しか知らないパスワードやAPIキーが、.envや設定ファイルの中にそのまま残っていることがあります。フォルダ全体を読ませる前に、中身に見覚えのないキーや個人情報が無いか、一度自分の目で確認してください。見つかった場合は、そのファイルを除いた場所で作業するか、権限設定で読み込みを拒否しておきます。

説明はコードで確かめる

Claudeの説明はもっともらしく聞こえても、実際のコードとずれていることがあります。特に「危なそうな箇所」の指摘は、そこを触る前に必ず該当ファイルを開いて、指摘どおりの作りになっているか確認してください。確認を省略したまま次の判断に進むと、思わぬところで動きが変わることがあります。

機能を学ぶ

SourceAMPL LEARN
インストールと最初の対話

claude-code-101 02 Claude Codeを入れて、フォルダを指定して日本語で頼むまでの基本操作

次のレッスン
amplinc.com/learn/claude-code-101/02-setup-and-first-conversation
SourceAMPL LEARN
「これやっていい?」と聞かれたら(パーミッション)

claude-code-101 04 読むだけの操作と書き換える操作の違い、Yes/No/Always allowの使い分け

次のレッスン
amplinc.com/learn/claude-code-101/04-tools-and-permissions
SourceAMPL LEARN
Plan mode(プランモード) 先に考えさせる

claude-code-yougo ファイルを変更せず計画だけ出させる読み取り専用モードの仕組み

次のレッスン
amplinc.com/learn/claude-code-yougo/09-plan-mode

このレッスンは役に立ちましたか?