界面已本地化;技能介绍与说明文档按所选语言由 AI 自动翻译,代码、命令、路径和专业术语保留原文,以原作者文档为准。
探索技能
文档与办公 · SKILL.md

docs-search

docs-search

【文档与办公】Search auto-generated codebase documentation for function signatures, API docs, class definitions, and code comments. Use when the user asks to "search docs", "find documentation", "look up a function", "check the API", or before implementing changes to verify correct signatures and patterns.

独立 GitHub 快照 · 自动分类 · 以原作者文档为准

技能说明

GitHub

name: docs-search description: Search auto-generated codebase documentation for function signatures, API docs, class definitions, and code comments. Use when the user asks to "search docs", "find documentation", "look up a function", "check the API", or before implementing changes to verify correct signatures and patterns.

AI Maestro Documentation Search

Search your codebase's auto-generated documentation for function signatures, class definitions, API docs, and code comments. Verify correct patterns before writing code. Part of the AI Maestro suite.

Prerequisites

Requires AI Maestro running locally with documentation indexed.

# Install doc tools
git clone https://github.com/23blocks-OS/ai-maestro-plugins.git
cd ai-maestro-plugins && ./install-doc-tools.sh

Core Behavior

Before implementing any code changes, search docs first:

Receive instruction -> Search docs -> Then implement

Commands

Search

CommandDescription
docs-search.sh <query>Semantic documentation search
docs-search.sh --keyword <term>Exact keyword matching
docs-find-by-type.sh <type>Find by type (function, class, module)
docs-get.sh <doc-id>Get full document content

Index

CommandDescription
docs-index.sh [path]Full index from project
docs-index-delta.sh [path]Delta index (new/modified files only)
docs-list.shList all indexed documents
docs-stats.shIndex statistics

Document Types

TypeSources
functionJSDoc, RDoc, docstrings
classClass-level comments
moduleModule/namespace comments
interfaceTypeScript interfaces
componentReact/Vue component comments
readmeREADME files
guidedocs/ folder content

Usage Examples

# 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

Full AI Maestro Experience

This skill is part of the AI Maestro platform, which provides 6 skills for AI agent orchestration: messaging, memory, docs, graph, planning, and agent management.

我的收藏