skills.rest
tylerburleigh
tylerburleighCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

doc-query

Query machine-readable codebase documentation for classes, functions, modules, and dependencies.

9|3|Updated Oct 24, 2025
Search Tags:#developer tools#code analysis#refactoring#dependencies#complexity#documentation query#code exploration
One-click install
npx skills add https://github.com/tylerburleigh/claude-sdd-toolkit --skill doc-query
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-query
Source: https://github.com/tylerburleigh/claude-sdd-toolkit/tree/main/skills/doc-query
Command: npx skills add https://github.com/tylerburleigh/claude-sdd-toolkit --skill doc-query

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates the need for manual code exploration by providing fast, structured query capabilities for machine-readable codebase documentation. It allows you to quickly find classes, functions, modules, dependencies, and complexity metrics without directly parsing source code, saving significant time.

Core Features & Use Cases

  • Targeted Entity Lookup: Find classes, functions, and modules by exact name or regex pattern.
  • Module Summaries: Get rich summaries of modules, including docstrings, key entities, and complexity signals.
  • Complexity & Dependency Analysis: Identify refactoring candidates and understand module relationships for impact analysis.
  • Use Case: When debugging an unfamiliar part of the system, use this skill to quickly describe-module for an overview, find-function to locate the bug, and dependencies --reverse to understand its impact, all without opening a single file.

Quick Start

Check if documentation exists and get statistics

sdd doc stats

Find a specific class by name

sdd doc find-class WizardSession

Describe a module with its key functions and docstrings

sdd doc describe-module app/services/scoring.py --include-docstrings

Find all functions with complexity above a threshold

sdd doc complexity --threshold 10

Show what modules depend on a specific file (impact analysis)

sdd doc dependencies app/models/session.py --reverse

Frequently Asked Questions about doc-query

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I quickly find functions and classes in my codebase without opening files?▼

Query machine-readable codebase documentation using exact name or regex pattern lookup. Commands like `sdd doc find-class` and `sdd doc find-function` return matching entities instantly, eliminating manual file exploration and enabling fast debugging, refactoring, and feature work.

Can I analyze code dependencies and understand which modules depend on a specific file?▼

Yes. Run `sdd doc dependencies --reverse` on any file to map reverse dependencies for impact analysis. This identifies affected modules during refactoring, bug fixes, and feature implementation without parsing source code directly.

What's the best way to get an overview of a module with its functions and complexity metrics?▼

Use `sdd doc describe-module` to retrieve module summaries including docstrings, key entities, and complexity signals in one structured query. This accelerates onboarding to unfamiliar code sections and supports bug diagnosis and refactoring planning.

Do I need to parse source code manually to find high-complexity functions?▼

No. Run `sdd doc complexity --threshold [number]` to identify functions exceeding complexity thresholds directly from documentation. This surfaces refactoring candidates and risk areas without static analysis setup or source parsing.

How do I check if codebase documentation exists before running queries?▼

Execute `sdd doc stats` to verify documentation availability and retrieve generation statistics. This confirms the documentation is present and current before performing targeted entity lookups, dependency analysis, or complexity queries.

Can I use regex patterns to search for functions across multiple modules at once?▼

Yes. The find-function and find-class commands support regex pattern matching for bulk entity discovery. This enables cross-module search, exploration of naming conventions, and systematic identification of related functions during code exploration and refactoring.

Related Skills

Explore More Software Engineering Skills→
dmlguq456dmlguq456
7

analyze-project

Analyze codebases and generate structured Markdown documentation in .claude_reports/docs_code/.

Community
Advanced
MinhHoangDonoMinhHoangDono

ck:gkg

Builds a symbol graph from AST parsing to query definitions, usages, and relationships in Git repositories.

Community
Intermediate
dojoenginedojoengine
1

rust-call-graph

Generates ASCII call graphs showing caller–calle relationships for Rust functions via LSP call hierarchy endpoints.

Official
Intermediate
cosmoscaliburcosmoscalibur
1

ast-grep

Search codebases structurally using AST patterns via ast-grep.

Community
Advanced