← ClaudeAtlas

repo-cartographerlisted

Maps an unfamiliar codebase into a visual onboarding document (docs/architecture.md) with Mermaid diagrams — system layers, module dependencies, a traced core data flow — plus an opinionated 5-file reading order. Use when the user asks to understand, explain, map, diagram, or onboard onto a repository, or says things like "how is this project organized", "where do I start reading", "draw the architecture", or "/map".
wenshuocui50-droid/repo-cartographer · ★ 1 · Data & Documents · score 69
Install: claude install-skill wenshuocui50-droid/repo-cartographer
# Repo Cartographer Turn any repository into a map a newcomer can read in 10 minutes: **`docs/architecture.md`**. ## Output contract One file: `docs/architecture.md`, with exactly these sections in this order: 1. **TL;DR** — what the project does (2–3 sentences) + tech stack in one line + the archetype you classified (see Phase 2). 2. **System Map** — Mermaid `flowchart` of top-level components/layers and how they connect. 3. **Module Dependencies** — Mermaid `flowchart` of who imports/calls whom. Core modules only. 4. **Core Flow** — one Mermaid `sequenceDiagram` of the most representative runtime flow (e.g. a request from entry to response, a command from argv to output). 5. **Reading Order** — exactly 5 files, in order, each with a one-line reason. This is the most valuable section: be opinionated. 6. **Conventions** — small table: build command, test command + where tests live, error-handling style, naming style, anything surprising. If `docs/architecture.md` already exists, overwrite it and say so. ## Method Work in four phases. Do not skip phases; each feeds the next. ### Phase 1 — Scout (breadth, not depth) Goal: build an inventory, not an understanding. - Read the manifest first: `package.json` / `pyproject.toml` / `go.mod` / `Cargo.toml` / `pom.xml` / `*.csproj`, etc. Note entry points (`main`, `bin`, scripts), major dependencies, module/workspace declarations. - Read the README (and the `docs/` index if present) for the project's own self-description. - Li