docs-search について
AI Maestro スイートのドキュメント検索スキルです。コードベースのインデックス済み自動生成ドキュメントを検索し、実装前の API や定義、コードパターンの確認に役立ちます。
主な機能
- 01ドキュメントのセマンティック検索
- 02キーワードの完全一致検索
- 03種類別のドキュメント検索
- 04ドキュメント全文の取得
- 05全ファイルまたは変更分のインデックス作成
活用シーン
- 01実装前の関数シグネチャ確認
- 02クラスやインターフェース文書の検索
- 03API やコードコメントのパターン確認
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/docs-searchを入力して読み込まれたか確認します。
詳細
AI Maestro ドキュメント検索
コードベースの自動生成ドキュメントから、関数シグネチャ、クラス定義、API ドキュメント、コードコメントを検索します。コードを書く前に、正しいパターンを確認できます。AI Maestro スイートの一部です。
前提条件
ドキュメントのインデックスが作成された状態で、ローカルで AI Maestro が実行されている必要があります。
# Install doc tools
git clone https://github.com/23blocks-OS/ai-maestro-plugins.git
cd ai-maestro-plugins && ./install-doc-tools.sh
基本動作
コードを変更する前に、必ず先にドキュメントを検索してください:
Receive instruction -> Search docs -> Then implement
コマンド
検索
| コマンド | 説明 |
|---|---|
docs-search.sh <query> | セマンティックなドキュメント検索 |
docs-search.sh --keyword <term> | 完全一致のキーワード検索 |
docs-find-by-type.sh <type> | 種類で検索（function、class、module） |
docs-get.sh <doc-id> | ドキュメントの全内容を取得 |
インデックス
| コマンド | 説明 |
|---|---|
docs-index.sh [path] | プロジェクト全体のフルインデックス作成 |
docs-index-delta.sh [path] | 差分インデックス（新規・変更されたファイルのみ） |
docs-list.sh | インデックス済みの全ドキュメントを一覧表示 |
docs-stats.sh | インデックスの統計情報 |
ドキュメントの種類
| 種類 | ソース |
|---|---|
function | JSDoc、RDoc、docstring |
class | クラスレベルのコメント |
module | モジュール／名前空間のコメント |
interface | TypeScript のインターフェース |
component | React／Vue コンポーネントのコメント |
readme | README ファイル |
guide | docs/ フォルダの内容 |
使用例
# Semantic search
docs-search.sh "authentication flow"
# Keyword search for specific identifier
docs-search.sh --keyword "UserController"
# Find all class documentation
docs-find-by-type.sh class
# Get full document details
docs-get.sh doc-abc123
# Index your codebase (first time)
docs-index.sh /path/to/project
# Update index after changes
docs-index-delta.sh
AI Maestro の全機能
このスキルは AI Maestro プラットフォームの一部であり、AI エージェントのオーケストレーション向けに 6 つのスキルを提供します。その範囲は、メッセージング、メモリ、ドキュメント、グラフ、計画、エージェント管理です。
コメント
Markdown 対応