codebase-explainer

Map documentation chapters to source files and generate ASCII architecture diagrams.

Updated Mar 25, 2026
One-click install
npx skills add https://github.com/ys0714/ecom-agent --skill codebase-explainer-ys0714
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: codebase-explainer
Source: https://github.com/ys0714/ecom-agent/tree/main/.claude/skills/codebase-explainer
Command: npx skills add https://github.com/ys0714/ecom-agent --skill codebase-explainer-ys0714

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

It turns fragmented repository documentation and source code into a clear, human-readable mapping and step-by-step explanation so engineers and reviewers can quickly understand architecture and core implementations.

Core Features & Use Cases

  • Module-to-file mapping: Produce an ordered mapping of documentation chapters or features to the repository's core source files for onboarding or audits.
  • Readable ASCII diagrams: Generate Unicode box-drawing architecture and data-flow diagrams that emphasize business components and data movement.
  • Targeted code walkthroughs: Extract minimal, focused code snippets with exact line-range references and explain intent, implementation choices, and design patterns.

Quick Start

Ask the agent to "Explain the repository structure, map each documentation chapter to its primary source files, and produce a human-readable ASCII architecture diagram with stepwise code walkthroughs".

Frequently Asked Questions about codebase-explainer

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

FAQPage Schema
How do I generate ASCII architecture diagrams from repository source code?

This Skill maps documentation sections to corresponding source files and produces Unicode box-drawing ASCII architecture diagrams that visualize business components and data movement. It outputs human-readable diagrams for architecture reviews and onboarding.

How do I map documentation chapters to specific source files for an onboarding audit?

Mapping documentation to source files produces an ordered mapping of documentation chapters or features to the repository's core source files. This module-to-file mapping clarifies architecture relationships for onboarding and technical audits.

What is the best way to create step-by-step code walkthroughs with minimal snippets?

Creating code walkthroughs involves extracting minimal, focused code snippets with exact line-range references from the source tree. The output provides step-by-step narration explaining implementation intent, design choices, and architectural patterns.

Does this approach work for codebases with fragmented documentation and source tree contexts?

Yes, it processes codebases with fragmented repository documentation and source tree contexts. It transforms these inputs into clear module-to-file mappings and structured walkthroughs for architecture reviews, onboarding, and technical audits.

When do I need Unicode box-drawing diagrams for a codebase architecture review?

You need Unicode box-drawing diagrams during architecture reviews, onboarding, and technical audits when clear module-to-file mappings and visual data-flow representation are required. They provide human-readable architecture visualization emphasizing business components and data movement.