A custom agent skill designed to analyze, and document unfamiliar backend codebases.
Stepping into a new backend repository can be overwhelming. This skill acts as a Senior Staff Engineer pairing with you, stripping away boilerplate and noise to extract the core architectural context, data flow, and the "why" behind historical design decisions.
Instead of mindlessly reading lines of code, this agent operates with a minimalist mindset to generate a Minimalist Onboarding Survival Guide. It systematically maps out dependencies (like go.mod or package.json), entry points (like cmd/ or router setups), and critical domain logic, saving you hours of cognitive load.
To use this skill, you need to have the Gemini CLI / Claude Code / Antigravity skills installed and configured.
- Clone this repository or download the skill folder:
git clone https://github.com/allanbian1017/backend-codebase-navigator.gitMove the folder into your Gemini CLI / Claude Code / Antigravity skills directory.
Ensure the structure looks like this:
backend-codebase-navigator/
└── SKILL.md
The agent is instructed to execute a strict 4-phase analysis and will output a clean Markdown document containing:
The 10,000-Foot View: A domain glossary and a Mermaid.js System Context Diagram mapping external integrations (PostgreSQL, Redis, Kafka, etc.).
The 1,000-Foot View: A flat directory map and a "Front Door" list identifying all primary API routes and event consumers.
Ground Level: A simplified Entity-Relationship (ER) model and a Sequence Diagram tracing the most critical "Happy Path" in the system.
Operational Reality: A copy-pasteable local setup runbook, "Trapdoors & Gotchas" for troubleshooting, and SCQA (Situation, Complication, Question, Answer) documentation for any complex historical design choices.
Contributions, issues, and feature requests are welcome! Feel free to check the issues page.
This project is licensed under the Apache License 2.0.