
【簡単】NotebookLMでBacklogのRAG構築をするための方法
こんにちは、リテールアプリ共創部の戸田駿太です。
今回は、Backlogのプロジェクト情報を活用してNotebookLMでRAGを構築する方法をご紹介します。
プロジェクト管理ツールであるBacklogには、過去の課題、Wiki、コメントなど貴重な情報が蓄積されていますが、それらの情報を効率的に検索・活用してAIで業務効率化することができます!
🛠️ 使用するツール
今回活用するのは以下の2つのツールです:
- backlog-exporter: BacklogのデータをローカルにエクスポートするCLIツール
- md-concatter: 複数のMarkdownファイルを統合するCLIツール
どちらも僕が作成したツールです。
これらを組み合わせることでシンプルにRAGシステムを構築できます。
🏗️ 構築手順
ステップ1: backlog-exporterでデータをエクスポート
まず、backlog-exporterを使ってBacklogのデータをローカルに取得します。
# Backlogのデータをエクスポート
npx backlog-exporter@latest all --domain あなたのドメイン.backlog.jp --projectIdOrKey プロジェクトキー --apiKey あなたのAPIキー
API KeyはBacklogの設定から取得できます。
参考記事:Backlog APIの設定
エクスポートされたデータは、以下のような構造でMarkdown形式で保存されます:
backlog/
├── issues/
│ ├── PROJ-001.md
│ ├── PROJ-002.md
│ └── ...
└── wiki/
├── Home.md
├── API仕様書.md
└── ...
課題ファイルには、課題の詳細だけでなく関連するコメントも含まれています。
ステップ2: md-concatterでファイルを統合
次に、エクスポートされた大量のMarkdownファイルをmd-concatterで数個のファイルにまとめます。
# 課題データをまとめる
npx md-concatter@latest ./backlog/issues -o backlog-issues.md
# Wikiデータをまとめる
npx md-concatter@latest ./backlog/wiki -o backlog-wiki.md
これにより、大量の個別ファイルが以下のような統合ファイルになります:
backlog-issues.md
- 全課題の情報(コメントも含む)backlog-wiki.md
- 全Wiki記事
ステップ3: NotebookLMにアップロード
統合されたMarkdownファイルをNotebookLMにソースとしてアップロードします。
- NotebookLMにアクセス
- 「新規作成」で新しいノートブックを作成
- 「ソースを追加」からmd-concatterで作成したMarkdownファイルをアップロード(ドラックアンドドロップでも可)
ステップ4: RAGシステムの完成
これで、BacklogのデータをベースにしたRAGシステムの完成です!
NotebookLMでBacklog内にある情報から以下のような回答ができるようになります!
- 「プロジェクトXで発生した主要な課題は何ですか?」
- 「API仕様について教えてください」
- 「過去に似たような問題はありましたか?」
- 「このエラーの解決方法を教えてください」
さらに、NotebookLMでは最近共有機能が追加されたため、作成したRAGシステムをチームメンバーと共有することも可能です!これにより、チーム全体でBacklogの情報を効率的に活用できるようになります。 👥
✅ メリット
情報検索の正確性向上
Backlogの正確なデータをソースとして使用するため、NotebookLMの回答の信頼性が大幅に向上します。推測ではなく、実際のプロジェクト履歴に基づいた回答を得られます。
構築の簡単さ
既存のツールを組み合わせるだけなので、複雑な開発やセットアップは不要です。コマンドを数回実行するだけでRAGシステムが完成します。
横断的な情報検索
課題、Wiki、コメントなど、Backlog内の様々な情報を横断的に検索できるため、関連情報を見落とすリスクが減ります。
チームでの情報共有
NotebookLMの共有機能により、構築したRAGシステムをチーム全体で活用できます。新しいメンバーのオンボーディングや、プロジェクトの知識共有が格段に効率化されます。
⚠️ デメリット
手動更新の必要性
最新情報を反映するには、同じ手順を再度実行する必要があります。ただし、将来NotebookLMのAPIが提供されれば、自動化の可能性もあります。
技術的知識の要求
コマンドラインツールを使用するため、基本的なCLI操作の知識が必要です。非技術者には少しハードルが高いかもしれません。
ファイルサイズの制限
NotebookLMには1つのソースあたりのファイルサイズ制限があるため、大規模なプロジェクトの場合は適切にファイルを分割する必要があります。
🎯 まとめ
backlog-exporterとmd-concatterを組み合わせることで、シンプルかつ効果的なBacklog RAGシステムを構築できました。
この方法の最大の魅力は、既存ツールの組み合わせで実現できる手軽さと、Backlogの正確なデータを活用できる信頼性です。
プロジェクトの知識管理や新メンバーのオンボーディング、過去事例の調査など、様々な場面で活用できるでしょう。
# 今すぐ試してみましょう
npx backlog-exporter@latest all --domain あなたのドメイン.backlog.jp --projectIdOrKey プロジェクトキー --apiKey あなたのAPIキー
npx md-concatter@latest ./backlog
この手法はBacklogだけではなく、他のプロジェクト管理ツールでも同様の手順でRAGを構築することができそうです。
ぜひ一度お試しください!
🔗 参考リンク