AIを活用したコードリーディングの手順についての雑多なメモ。
プロンプトの工夫などもあればよいが、プロセスだけまとめておく。
プロンプトでコードの全体と読むべき重要な部分を確認する。
その際、READMEや他のドキュメント、ツール（コールグラフなど）を活用して、全体像の把握が概ね正しそうか確認する。
データ構造やシーケンスについても確認できると良い。
プロンプトで、コードリーディング手順書作成を依頼する。
コードリーディングの目的に合わせて作成するようにする。
最低限コードを読む順番とチェックリストがあると良い。短時間で読める量ならチェックリストは不要だが、時間を要する場合は進捗管理できる簡易的なチェックリストを用意しておくと脳内ワーキングメモリをダンプできるので便利。
手順書に従ってコードを読む。
コードを読む際は、リーディングした要点をメモしておくと良いので、適当なフォーマットでメリーディングモを取れるようにファイルを用意しておく。AIに聞いたことはこのメモにまとめておくようにすると、メモを取る手間が大きく省け、コードを読むことに集中できる。
また、コードリーディング中に改善点が見つかることあるので、こちら同様にメモしておくと良い。
以下をAIを活用して効率的に行う。
丁寧により深く理解をする必要があるのであれば、自分的システムの仕様書の構成といった資料を作成するのも良い。