moai-workflow-jit-docs

クイックリファレンス（30秒）

目的：ユーザーの意図とコンテキストに基づいて、関連するドキュメントを必要に応じて読み込みます。

主なツール：

• WebSearch：最新のドキュメントやリソースをオンラインで検索します
• WebFetch：特定のドキュメントページを取得します
• Context7 MCP：公式ライブラリドキュメントにアクセスします（利用可能な場合）
• Read、Grep、Glob：ローカルプロジェクトのドキュメントを検索します

トリガーパターン：

• ユーザーが具体的な技術的質問をする
• 会話内でテクノロジーのキーワードが検出される
• タスクの完了に専門知識が必要となる
• 実装ガイダンスが必要となる

実装ガイド

意図の検出

システムは、いくつかのパターンからドキュメントの必要性を認識します。

質問に基づくトリガー：

• ユーザーが具体的な実装について質問した場合（例：「JWT 認証を実装するにはどうすればよいですか？」）
• ベストプラクティスや最適化のガイダンスを求めている場合
• トラブルシューティングに関する質問が発生した場合

テクノロジー固有のトリガー：

• フレームワーク名の検出：FastAPI、React、PostgreSQL、Docker、Kubernetes
• ライブラリ名の検出：pytest、TypeScript、GraphQL、Redis
• ツール名の検出：npm、pip、cargo、maven

ドメイン固有のトリガー：

• 認証と認可に関するトピック
• データベースとデータモデリングに関する議論
• パフォーマンス最適化に関する問い合わせ
• セキュリティ関連の質問

パターンに基づくトリガー：

• 実装の依頼：「implement」、「create」、「build」
• アーキテクチャに関する議論：「design」、「structure」、「pattern」
• トラブルシューティング：「debug」、「fix」、「error」、「not working」

ドキュメントのソース

システムは、優先順位に従って複数のソースからドキュメントを取得します。

ローカルプロジェクトのドキュメント（最優先）：

• プロジェクト固有のドキュメントについては、.moai/docs/ を確認します
• 要件と仕様については、.moai/specs/ を確認します
• プロジェクトの概要については、README.md を確認します
• 詳細なドキュメントについては、docs/ ディレクトリを確認します

公式ドキュメントのソース：

• WebFetch を使用して、公式フレームワークのドキュメントを取得します
• ライブラリのドキュメントについては、利用可能な場合に Context7 MCP ツールを使用します
• テクノロジー固有の公式ウェブサイトにアクセスします

コミュニティリソース：

• WebSearch を使用して、質の高いチュートリアルを検索します
• 高い投票数を獲得した Stack Overflow の解決策を検索します
• 特定の問題について GitHub のディスカッションを探します

リアルタイムのウェブ調査：

• WebSearch で現在の年を指定して、最新情報を検索します
• 最近のベストプラクティスや更新情報を検索します
• 新機能や非推奨の通知を探します

読み込み戦略

意図分析のプロセス：

• ユーザーの依頼に含まれるテクノロジーを特定します
• 質問に関連するドメイン領域を判断します
• 質問の種類（実装、トラブルシューティング、概念）を分類します
• 必要なドキュメントの深さを判断するため、複雑さを評価します

ソースの優先順位付け：

• ローカルドキュメントがある場合：最初にプロジェクト固有のドキュメントを読み込みます
• 公式ドキュメントが利用できる場合：信頼できるソースを取得します
• 実装例が必要な場合：コミュニティリソースを検索します
• 最新情報が必要な場合：ウェブ調査を実施します

コンテキストを考慮したキャッシュ：

• 取得したドキュメントをセッション内にキャッシュします
• 現在の会話コンテキストに基づいて関連性を維持します
• コンテキストが変わったときは古いコンテンツを削除します
• 頻繁にアクセスされるドキュメントを優先します

品質評価

コンテンツ品質の評価：

• 権威性：公式ソースを最も信頼できるものとして扱います
• 新しさ：変化の速いテクノロジーでは、12か月以内のコンテンツを優先します
• 網羅性：例を含むドキュメントを高く評価します
• 関連性：コンテンツとユーザーの意図との一致度を評価します

関連性の順位付け：

• ドキュメントの内容とユーザーの質問との一致度を算出します
• 権威性（30％）、新しさ（25％）、網羅性（25％）、関連性（20％）に重み付けします
• スコアの高いドキュメントから順に返します
• 取得した情報の確信度を示します

実践的なワークフロー

認証の実装ワークフロー：

• ユーザーが認証について尋ねた場合：使用技術を検出します（例：FastAPI、JWT）
• ドメインを特定します：認証、セキュリティ
• WebFetch を使用して FastAPI のセキュリティドキュメントを読み込みます
• WebSearch で JWT のベストプラクティスを検索します
• 出典を明記して、包括的なガイダンスを提供します

データベース最適化ワークフロー：

• ユーザーがクエリのパフォーマンスについて尋ねた場合：データベース技術を検出します
• ドメインを特定します：パフォーマンス、最適化
• データベースの公式ドキュメントを読み込みます
• 最適化ガイドとチュートリアルを検索します
• 出典を添えて、実行可能な推奨事項を提供します

新しい技術の導入ワークフロー：

• ユーザーがなじみのない技術を紹介した場合：技術名を検出します
• 公式の入門ドキュメントを読み込みます
• 該当する場合は、移行ガイドを検索します
• 既存のスタックとの統合パターンを見つけます
• 戦略的な導入ガイダンスを提供します

エラー処理

ネットワーク障害：

• Web 検索に失敗した場合：キャッシュされたコンテンツを使用します
• WebFetch に失敗した場合：利用可能であれば、ローカルドキュメントを使用します
• 一部の情報源にアクセスできない場合は、部分的な結果であることを明示します

コンテンツの品質に関する問題：

• 取得したコンテンツが古いと思われる場合：より新しい情報源を検索します
• 関連性が不明確な場合：ユーザーに確認を求めます
• 情報が矛盾している場合：日付とともに複数の情報源を提示します

関連性の不一致：

• 最初の検索結果の精度が低い場合：検索クエリを調整します
• ユーザーのコンテキストが不明確な場合：読み込み前に確認を求めます
• ドキュメントに不足がある場合：その制限を認めます

パフォーマンスの最適化

キャッシュ戦略：

• 頻繁にアクセスするドキュメントのセッションレベルのキャッシュを維持します
• プロジェクト固有のドキュメントをメモリに保持します
• アクセス時刻に基づいて古いコンテンツを削除します

効率的な読み込み：

• 明示的に必要な場合にのみドキュメントを読み込みます
• あらゆるドキュメントを事前に読み込むことは避けます
• 広範なクエリではなく、対象を絞った検索を使用します

バッチ処理：

• 可能な場合は、関連する検索をまとめます
• 技術ごとにドキュメントのリクエストをグループ化します
• 適切な場合は、複数の情報源を並行して処理します

高度なパターン

複数の情報源の集約：

• 公式ドキュメントとコミュニティの実例を組み合わせます
• 複数の信頼できる情報源を相互参照します
• 多様な資料から包括的な回答をまとめます

コンテキストの保持：

• 会話内で先に読み込んだドキュメントを記憶します
• 同じドキュメントの重複読み込みを避けます
• セッションを通じて知識を蓄積します

先回りした読み込み：

• 会話の流れから必要なドキュメントを予測します
• 複雑な機能について話す際は、関連トピックを事前に読み込みます
• ユーザーから尋ねられる前に、関連するドキュメントを提案します

---

相性のよいツール

エージェント：

• workflow-docs：ドキュメントの生成
• core-planner：ドキュメントの計画
• workflow-spec：SPEC ドキュメント

スキル：

• moai-docs-generation：ドキュメントの生成
• moai-workflow-docs：ドキュメントの検証
• moai-library-nextra：Nextra ドキュメント

コマンド：

• /moai:3-sync：ドキュメントの同期
• /moai:9-feedback：ドキュメントの改善