learn-codebase

Generate a Markdown domain map and Mermaid diagrams from a codebase exploration.

Updated Mar 4, 2026
One-click install
npx skills add https://github.com/vndkubi/bootstrap-toolkits --skill learn-codebase
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: learn-codebase
Source: https://github.com/vndkubi/bootstrap-toolkits/tree/main/.github/skills/learn-codebase
Command: npx skills add https://github.com/vndkubi/bootstrap-toolkits --skill learn-codebase

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Onboarding new team members and understanding large codebases is time-consuming without a structured, domain-focused exploration and documentation workflow.

Core Features & Use Cases

  • Domain discovery: identify package structure, entities, services, controllers, and data models to map business domains.
  • Workflow tracing: track major flows from entry points to data stores, including business rules and external integrations.
  • Documentation generation: produce a domain map, Mermaid ER diagram, sequence diagrams, and an external integrations map for a comprehensive learning report.

Quick Start

Start the learning workflow on a repository to produce a domain map and exploration report.

Frequently Asked Questions about learn-codebase

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

FAQPage Schema
How do I map a codebase to understand its business domains and workflows?▼

To map a codebase, you identify package structures, entities, and controllers to document business domains. This traces major workflows from entry points to data stores, generating a domain map and Mermaid sequence diagrams.

What is the best way to generate ER diagrams and sequence diagrams for codebase onboarding?▼

The best way to generate ER diagrams and sequence diagrams for onboarding is structuring domain-focused exploration. This tracks major flows and data models, producing Mermaid ER diagrams and sequence diagrams to capture business and technical perspectives.

How do I document external integrations and business rules when learning a new codebase?▼

To document external integrations and business rules when learning a codebase, you trace major workflows from entry points to data stores. The exploration output is saved as a Markdown report under docs/exploration, including notable gotchas.

Can I generate domain maps and exploration reports for multiple tech stacks?▼

Yes, you can generate domain maps and exploration reports for multiple tech stacks. The workflow captures business and technical perspectives, mapping entities, services, and data models across different frameworks.

How do I create a codebase exploration report to accelerate feature discovery?▼

You create a codebase exploration report to accelerate feature discovery by identifying domains, workflows, and data models. The output is saved as a Markdown file under docs/exploration/[domain-or-feature]-overview.md, detailing external integrations.