Overview
公開リポジトリ向け
高度なコード検索、プランニング、セッション作成を含む Ask Devin のすべての機能は、Devin アプリ で利用できます。Public DeepWiki と DeepWiki MCP では、基本的なドキュメントおよび Q&A 機能を提供します。
DeepWiki の制御

.devin/wiki.json ファイルを使うと、Devin のデフォルトの wiki 生成動作を制御できます。これは、組み込みの制限に達する可能性がある大規模リポジトリでは特に重要です。
wiki 生成中にリポジトリのルートディレクトリで .devin/wiki.json ファイルが見つかった場合、指定された repo_notes と pages を使用して wiki 生成を制御します。pages が指定されている場合、デフォルトのクラスターベースのプランニングをスキップし、指定したページだけを正確に作成します。これにより、自動生成システムではスキップされてしまう場合でも、コードベースの重要な部分が確実にドキュメント化されるようになります。
設定形式
.devin/wiki.json ファイルを作成します。
設定項目
repo_notes (Array)
- content (string, required): ノートの内容 (最大 10,000 文字)
- author (string, optional): ノートの作成者
pages (Array, optional)
repo_notes のみを含めた場合でも、システムはあなたのノートをもとに構成と重点を判断して wiki を生成し、すべてのページを個別に定義する必要はありません。
pages を指定した場合、それらは明示的な指示として扱われます。JSON で定義したページのみが生成され、それ以上でもそれ以下でもありません。
- title (string, required): ページタイトル (一意かつ空でない必要があります)
- purpose (string, required): このページで何を文書化するか
- parent (string, optional): 階層構造のための親ページのタイトル
- page_notes (array, optional): このページに固有の追加ノート
検証の制限
- 最大 30 ページ (エンタープライズでは 80 ページ)
- ノート数は合計で最大 100 個 (
repo_notesとすべてのpage_notesの合計) - ノート 1 件あたり最大 10,000 文字
- ページタイトルは一意で、かつ空であってはなりません
実用例
例 1: Wiki 生成をガイドする Repo Notes の利用
repo_notes のみを指定できます。これにより、Devin はあなたの優先事項や注力したい領域を考慮しながら、ドキュメント構造を自動的に作成できます。これは、すべてのページを自分で明示的に設計しなくても、カバレッジと重点箇所をより適切に高めたい場合に有用です。
例 2: 特定のフォルダがドキュメントに含まれるようにする
例 3: ドキュメント化されていないコンポーネントへの対処
例 4: 階層的なドキュメント構造
ベストプラクティス
1. Repo Notes を戦略的に活用する
- コードベースのうち、どの部分が特に重要かについてのコンテキストを提供する
- 優先すべき特定のフォルダやコンポーネントに言及する
- システム内の各部分同士の関係を説明する
2. ページを論理的に整理する
- まずは高レベルな概要ページから始める
- 親子関係を設定して明確な階層構造を作る
- 関連する機能をまとめて整理する
3. ページの目的を具体的にする
- 各ページで何を文書化すべきかを明確に記載する
- 注力したい特定のディレクトリ、ファイル、または概念を明示する
- システムが意図を理解できるだけの十分な詳細を提供する
4. 既知の抜け漏れに対処する
- コードベース内で特定の部分が見落とされているとわかっている場合は、それらを明示的に含めるようにする
- 何を対象としているかが一目でわかる、説明的なタイトルを付ける
一般的な問題のトラブルシューティング
「一部のフォルダしかドキュメント化されない」
.devin/wiki.json を使って、コードベースのどの部分をドキュメント化するかを明示的に指定してください。
「重要なコンポーネントが wiki から抜けている」
はじめに
- リポジトリのルートに
.devin/wiki.jsonを作成します - コードベースの構造や優先度を説明する
repo_notesを追加します - 必要に応じて、作成したいすべてのページを漏れなく指定し、それぞれに明確なタイトルと目的を設定します
- ファイルをコミットし、wiki を再生成します

