adk-docs

ADK ドキュメント管理

ユーザーが ADK プロジェクトのドキュメントを作成、レビュー、更新、または保守する際に、このスキルを使用します。ユーザーは自身のボットや機能に関するガイドやドキュメントを作成します。コード例には、ユーザーのプロジェクトと公式 ADK リポジトリのコードを使用してください。

このスキルを使用する場面

次のような場合に、このスキルを有効にします。

• ボットのドキュメントを作成したい場合（「注文ワークフローをドキュメント化して」「カスタムアクションのガイドを書いて」）
• 既存のプロジェクトドキュメントが正確かどうか確認したい場合（「ドキュメントがまだ正確か確認して」）
• ボットの変更後にドキュメントを更新したい場合（「チェックアウトのフローをリファクタリングしたので、ドキュメントを更新して」）
• ドキュメントがコードと同期しているか確認したい場合（「ドキュメントは最新ですか？」）
• プロジェクトのドキュメントを検索したい場合（「決済ハンドラーに関するドキュメントを探して」）
• ドキュメントの標準やテンプレートについて質問した場合
• /adk-document に言及した場合

利用可能なドキュメント

ファイル	説明
references/doc-standards.md	ドキュメントの種類、テンプレート、品質チェックリスト、健全性指標

利用可能なコマンド

コマンド（推奨サブコマンド）	説明
/adk-document create [topic]	ユーザーのボットの機能に関するドキュメントを作成します
/adk-document review [doc-path]	プロジェクトのドキュメントの正確性と網羅性をレビューします
/adk-document update [doc-path] [what-changed]	コード変更後にプロジェクトのドキュメントを更新します
/adk-document sync [optional-doc-path]	プロジェクトのドキュメントがボットのコードと同期しているか確認します
/adk-document search [search-term]	特定のトピックについてプロジェクトのドキュメントを検索します

共通原則

1. AI に最適化された構成

• ripgrep でセクションを検索できるよう、明確なセクション見出し（##、###、####）を使用します
• 冒頭にアンカーリンク付きの目次を配置します
• ドキュメントの種類に応じた適切な分量にします（doc-standards のリファレンスを参照）
• キーワードを含むセクション名を使用します。「高度なトピック」や「その他」のような曖昧な見出しは避けます

2. コードを優先するアプローチ

• すべての概念に、実際のプロジェクトコードに基づく動作するコード例が必要です
• 検証できるよう、行番号付きのファイルパスを含めます
• 例の主な情報源（優先順位順）：
  1. ユーザー自身の ADK プロジェクト（ワークスペース内の agent.config.ts を探します）—最優先
  2. 公式 ADK リポジトリの例（クローンするか、ローカルで探します）
  3. ADK ランタイムの使用例（@botpress/runtime パッケージ）
• 例を捏造したり推測したりしないでください。すべてのコードは検証可能である必要があります

3. 重要な違い

• ADK プリミティブ（@botpress/runtime に由来）と Botpress SDK プリミティブ
• 会話内の this.send() とワークフロー内の client.createMessage()
• メッセージ（永続的に保存される）とイベント（一時的で、保存されない）
• 汎用 API とチャネル固有の機能

4. 推測しない

• ユーザーから明示的に提供されていない限り、「よくある間違い」や「ベストプラクティス」のセクションを追加しないでください
• 実際に報告されたエラーをドキュメント化する場合にのみ、❌ WRONG / ✅ CORRECT を使用します
• ワークフローや例は、想像ではなく実際のコードで検証する必要があります

5. 執筆スタイル

• 直接的で、すぐに実行できる内容 — 「this.send() を使用します」とし、「検討してみてもよいかもしれません」は避けます
• 技術的に正確 — 実際の ADK コードで例をテストします
• 読者の理解力を前提とする — 過度に手取り足取りせず、背景と指針を示します
• 宣伝文句は不要 — 技術的な内容を簡潔に述べます

回答方法

ユーザーが特定のコマンドを実行せずにドキュメントについて尋ねた場合：

1. ADK のコンテキストと知識を把握するため、adk スキルを読み込みます（必要に応じてほかのスキルも読み込みます）
2. ユーザーが必要としていることを特定します — 作成、レビュー、更新、同期、検索
3. 適切なコマンドを案内するか、上記の原則に沿って直接サポートします
4. テンプレートと品質に関するガイダンスとして、doc-standards を参照します

ドキュメントの保存場所

ドキュメントはユーザー自身のプロジェクト内に作成します。保存場所が明らかでない場合は、ユーザーに保存先を尋ねてください（一般的な場所：./docs/、./guides/、またはプロジェクトのルート）。

コードソースの確認

例を確認するため、ユーザーのプロジェクトと公式 ADK リポジトリを特定します。

// Find ADK projects in the workspace
Glob({ pattern: '**/agent.config.ts' })

// Find ADK runtime usage in the user's project
Grep({ pattern: 'from [\'"]@botpress/runtime', output_mode: 'files_with_matches' })

// Look for existing project documentation
Glob({ pattern: './{docs,guides}/**/*.md' })

// Find official ADK examples if available locally
Glob({ pattern: '**/adk/examples/**/*.ts' })

相互参照

• adk スキル — ADK の中核知識（アクション、ワークフロー、会話など）
• adk-evals スキル — テストと評価のドキュメント
• adk-frontend スキル — フロントエンド統合のドキュメント
• adk スキルの integrations.md リファレンス — 統合のライフサイクルに関するドキュメント