概要
https://qiita.com/a32-suzuki/items/c3540da3e009dab1bf97
詳細内容
## 【コピペOK】GitHub Copilotを"DeepWiki化"するドキュメント指示書を作成してみた
https://qiita.com/a32-suzuki/items/c3540da3e009dab1bf97
GitHub Copilotを活用し、Devinの「DeepWiki」機能を模倣したプロジェクトの自動ドキュメント生成を可能にする「ドキュメント指示書」の作成手法と具体的な内容を解説します。
**Content Type**: ⚙️ Tools
**Language**: ja
**Scores**: Signal:4/5 | Depth:4/5 | Unique:4/5 | Practical:5/5 | Anti-Hype:4/5
**Main Journal**: 86/100 | **Annex Potential**: 84/100 | **Overall**: 84/100
**Topics**: [[GitHub Copilot, ドキュメント生成, プロンプトエンジニアリング, Devin, Mermaid]]
この記事は、GitHub Copilotを使って、話題のAIエージェントDevinが持つ「DeepWiki」のような詳細なプロジェクトドキュメントを自動生成する「ドキュメント指示書」（プロンプト）の作成と活用方法を具体的に紹介します。社内環境でDeepWikiをすぐに利用できないという課題に対し、著者は既存のGitHub Copilotの機能を最大限に引き出すための工夫に着目しました。
作成されたドキュメント指示書は、単なるコード要約に留まらず、以下の重要な特徴を備えています。
1. **網羅的なプロジェクト解析**: ソースコードだけでなく、`package.json`や`Dockerfile`、`.github/workflows`などのビルドツールやインフラ設定ファイルまでスキャンし、プロジェクト全体像を把握します。
2. **柔軟なドキュメント構成**: `ドキュメント構成.md`ファイルをプロジェクト内に配置することで、生成されるドキュメントの章立てや順序をカスタマイズ可能。ファイルがない場合は、AIがコード構造を分析し最適な構成を自動決定します。
3. **図解による直感的なドキュメント生成**: Mermaid形式のアーキテクチャ図やシーケンス図などを自動生成し、テキストだけでは伝わりにくい情報を視覚的に表現します。
4. **自己タスク管理による安定性**: 全体を一度に生成するのではなく、TODOリストを作成し、1ページずつ生成して進捗を更新することで、長大なドキュメント生成プロセスでもAIが迷子になったり中断したりするのを防ぎます。
5. **厳格な出力ルールによる品質担保**: 見出しの絵文字、ファイル間リンク、コードスニペット、ソースコード参照（ファイルパスと行番号指定）など、具体的な出力形式を細かく指定することで、生成されるドキュメントの品質と一貫性を高めています。
著者はJava/Spring BootのTodoアプリで実践し、指示書通りにタスク分割が行われ、構成図やエンドポイント一覧などの図表を含む詳細なドキュメントが生成されたことを確認しました。
ただし、この手法には精度の限界、大規模プロジェクトにおける規模の限界、ビジネス背景や設計判断の理解不足といった課題も存在すると指摘しています。そのため、この指示書は「ドラフト作成時間を9割削減するツール」と捉え、最終的な仕上げは人間の手で行う現実的な付き合い方が重要だと結論づけています。
本記事は、プロンプトエンジニアリングの重要性を改めて示し、GitHub Copilotの新たな活用可能性として、将来的にはCIツール連携によるドキュメント自動更新など、さらなる応用が期待されます。