source-reading-guide

Generate layered PlainUML sequence diagrams and key-function tables for IDE-based source reading.

1|Updated Apr 7, 2026
One-click install
npx skills add https://github.com/eatbreads/.agents --skill source-reading-guide
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: source-reading-guide
Source: https://github.com/eatbreads/.agents/tree/main/skills/source-reading-guide
Command: npx skills add https://github.com/eatbreads/.agents --skill source-reading-guide

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill turns raw source code into an IDE-friendly, step-by-step reading navigation map so engineers can follow real execution flow without getting lost in dispatch, wrapper, or bridge layers and can distinguish confirmed versus unconfirmed call chains.

Core Features & Use Cases

  • Three-layer execution flow: high-level overview, detailed source-reading sequence, and focused drill-downs for 1–3 complex nodes.
  • PlainUML sequence and structure diagrams: function-level sequence diagrams and a static class/module diagram annotated for entry, dispatch, and backend roles.
  • Layered key-function table and terminology: a function table with explicit "why not skip" and "next step" guidance, plus inline project-specific term explanations.
  • Use Case: use when you need to follow execution across dispatch/adaptor layers, map calls back to IDE-reading order, or produce reproducible per-function reading tasks for reviewers.

Quick Start

Analyze the provided codebase and produce an IDE-friendly step-by-step source reading navigation map starting from the specified entry function.

Frequently Asked Questions about source-reading-guide

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

FAQPage Schema
How do I navigate a large codebase to follow the real execution flow in my IDE?▼

You can map execution flow in your IDE by generating a step-by-step source reading navigation map that tracks calls through dispatch and bridge layers, distinguishing confirmed versus unconfirmed call chains for accurate exploration.

What is a source reading navigation map for static analysis?▼

A source reading navigation map uses static analysis to produce layered PlainUML sequence diagrams, a static structure diagram, and a key-function table, explaining execution flow and preventing confusion across dispatch and wrapper layers.

How do I generate sequence diagrams for complex code calls and dispatch layers?▼

You generate sequence diagrams by analyzing the codebase from a specified entry function, which produces three layered PlainUML sequence diagrams covering high-level overviews, detailed reading sequences, and focused drill-downs for complex nodes.

Does this source reading guide work for mapping unconfirmed call chains?▼

Yes, the source reading guide handles unconfirmed call chains by explicitly mapping them alongside confirmed paths, using a layered key-function table that details inputs, outputs, side effects, and skip-justifications for every step.

When do I need a step-by-step code navigation map for call chains?▼

You need a code navigation map when following execution across dispatch or adaptor layers, mapping calls back to IDE-reading order, or producing reproducible per-function reading tasks for reviewers working within large codebases.