skills.rest
kokatsu
kokatsuCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

research

Investigate a codebase area and produce a structured research.md document.

Updated Aug 14, 2024
Search Tags:#architecture#documentation#research#onboarding#codebase#analysis#data-flow
One-click install
npx skills add https://github.com/kokatsu/dotfiles --skill research-kokatsu
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: research
Source: https://github.com/kokatsu/dotfiles/tree/main/.config/claude/skills/research
Command: npx skills add https://github.com/kokatsu/dotfiles --skill research-kokatsu

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Deep-dive investigations of a specified codebase area to produce a thorough, structured research document that informs planning and decision-making.

Core Features & Use Cases

  • Deeply read a target area, tracing function calls, imports, and data flows to understand behavior.
  • Compile findings into a well-structured research.md with sections for overview, architecture, data flow, and dependencies.
  • Support planning, risk assessment, and knowledge transfer by providing a reproducible research artifact.

Quick Start

Run /research <target folder, module, or system to investigate> to generate a comprehensive research.md in the current directory.

Frequently Asked Questions about research

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

FAQPage Schema
How do I generate architecture documentation for an unfamiliar codebase?▼

Codebase analysis for onboarding involves tracing imports, function calls, and data flows across a target module to understand behavior and compile findings into a structured research.md document.

What is the best way to trace data flow across a complex subsystem?▼

Codebase analysis for onboarding involves tracing imports, function calls, and data flows across a target module to understand behavior and compile findings into a structured research.md document.

How do I document a specific module for refactoring planning?▼

Codebase analysis for onboarding involves tracing imports, function calls, and data flows across a target module to understand behavior and compile findings into a structured research.md document.

Can I use automated codebase research for onboarding new developers?▼

Codebase analysis for onboarding involves tracing imports, function calls, and data flows across a target module to understand behavior and compile findings into a structured research.md document.

What sections are included in a generated research document?▼

Codebase analysis for onboarding involves tracing imports, function calls, and data flows across a target module to understand behavior and compile findings into a structured research.md document.

Does deep-dive codebase analysis work on any project directory?▼

Codebase analysis for onboarding involves tracing imports, function calls, and data flows across a target module to understand behavior and compile findings into a structured research.md document.

Related Skills

Explore More Software Engineering Skills→
spencerbeggsspencerbeggs

/design-docs:user-docs-create-readme

Generate README.md files from project structure and package.json.

Community
Intermediate
apsulliapsulli

GSD Codebase Mapper

Analyze multi-language codebases to generate ARCHITECTURE.md and STACK.md with technical debt maps.

Community
Advanced
PancrePal-xiaoyibaoPancrePal-xiaoyibao
6

codebase-context

Index codebase dependencies, call chains, and execution flows into a knowledge graph.

Official
Intermediate
ChegginCheggin
1

documentation-generator

Generate API references, user guides, and changelogs from code and git history.

Community
Advanced