はじめに
「このシステムの作成に携わった〇〇さんからの引継ぎ資料どうなっていますか？」
「設計書？そんなものないよ、ソースコード見て。」
「設計書に書いてあることと違う処理が行われている？？」
このような経験は、システムエンジニアをやっていく中で避けては通れない道かと思います。
上記のような悲しい思いから解放されたいということで、AIの力を借りてソースコードから設計書を作成する、いわゆるリバースエンジニアリングをしてみました。
Claude Codeとは
Claude Codeは、ターミナルで動作するエージェント型のツールで、自然言語を通じてタスク実行、複雑なコードの説明、Gitワークフローの処理などを支援することで、コーディングを高速化します。
より詳しい内容は公式ドキュメントを参照してみてください。
筆者はWindows環境なので、WSLを利用したUbuntu環境で動作させています。
サンプル用のサイトを作る
リバースエンジニアリング用のWebサイトをClaude Codeで作成します。
以下のような指示を出してサイトを作成させました。
- Node.jsを利用したユーザ管理用のWebサイトを作りたいです
- ユーザデータの管理はJSON形式のファイルで管理できるようにしてください
- ユーザデータの追加、編集、削除ができるようにしてください
出来上がったサイトがこちらです。
ここまで所要時間でいうと10分程度でした。（すでに感動）
ソースコードから設計書を作る
作成されたソースコードをもとに、設計書を出力させてみます。
設計書はWordファイルとして出力させてみます。
やりたいことをそのままClaude Codeに指示してみます。
出来上がったファイルがこちらです。
生成された設計書の内容
生成された設計書には以下のような内容が含まれていました：
- システム概要
- アーキテクチャ設計
- API仕様
- データ構造
- セキュリティ考慮事項
- デプロイメント手順
おわりに
Claude Codeを使うことで、たった数分でソースコードから体系的な設計書を自動生成することができました。
メリット
- 既存システムのドキュメント化が容易
- 引き継ぎ資料の作成時間を大幅に短縮
- コードと設計書の乖離を防げる
今後の展望
- より詳細な設計書のカスタマイズ
- 定期的なドキュメント更新の自動化
- 他のプロジェクトへの適用
設計書が存在しないレガシーシステムや、ドキュメントが古くなってしまったプロジェクトに対して、Claude Codeによるリバースエンジニアリングは非常に有効な手段だと感じました。
おわり！