explain

Analyze codebases with five lenses and generate layered reports with Mermaid diagrams.

1|Updated Mar 24, 2026
One-click install
npx skills add https://github.com/joesys/joesys-skills --skill explain-joesys
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: explain
Source: https://github.com/joesys/joesys-skills/tree/main/skills/explain
Command: npx skills add https://github.com/joesys/joesys-skills --skill explain-joesys

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Analyzes a codebase by deploying five parallel lenses (Structure, Behavior, Domain & Data, External Dependencies, Health & Risk) to produce a layered explanation that helps engineers understand how the system is built and where risks lie.

Core Features & Use Cases

  • Five-lens analysis: Converges findings into a single, structured report that starts with a quick overview and deep dives.
  • Scope-aware exploration: Works on whole projects or targeted scopes (directories, files, symbols) and respects user intent.
  • Operational guidance: Produces actionable insights and rationale to inform design decisions and risk mitigation.

Quick Start

Invoke /explain on a codebase or scope to generate the layered explanation report with the 5 lenses.

Frequently Asked Questions about explain

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

FAQPage Schema
How do I analyze a codebase to understand its architecture and risks?

To analyze a codebase, deploy five parallel lenses covering Structure, Behavior, Domain & Data, External Dependencies, and Health & Risk. This synthesizes a layered explanation report with Mermaid diagrams to clarify system architecture and highlight operational risks.

Can I generate documentation for a specific directory or file instead of a whole project?

Yes, codebase documentation can target a specific scope. You can apply analysis to a whole project by default or narrow it down to a specific directory, file, or symbol, respecting your scope intent while generating the same layered report.

What is the best way to visualize code structure and external dependencies?

The best way to visualize code structure is by generating layered reports with Mermaid diagrams. By applying analysis lenses to external dependencies and structural components, you receive visual diagrams and non-reproduced code pointers for clarity.

Does code analysis work without external dependencies or components?

Yes, code analysis works without external dependencies or components. The five-lens analysis operates intrinsically on the provided target codebase or scope to produce structural, behavioral, and health risk insights without requiring external setup.

How do I identify health and risk factors in a software engineering project?

Identify health and risk factors by deploying the Health & Risk lens during codebase analysis. This lens evaluates operational guidance and risk mitigation rationale, synthesizing findings into a layered report that highlights system vulnerabilities.

Why use multiple analysis lenses for codebase documentation instead of a single overview?

Multiple analysis lenses provide a comprehensive layered report rather than a shallow overview. Converging five distinct perspectives—Structure, Behavior, Domain, Dependencies, and Health—ensures deep operational guidance and uncovers risks a single overview would miss.