- Home
- Skills
- Technical Documentation
- Explain Architecture: Codebase Walkthrough for Any Stack
Explain Architecture: Codebase Walkthrough for Any Stack
Analyzes a codebase and writes a structured `docs/architecture.md`, explained at the depth that matches your experience level.
Free
Works with the AI Agents you already use
Explain Architecture: Codebase Walkthrough for Any Stack
Example session with this skill installed
Analyze this Go microservices repo for a senior engineer and generate an architecture report using subagents.
- Read your context and instructions
- Compiled the explain architecture
I have analyzed the repository across four microservices and the shared library. The detailed report has been generated to docs/architecture.md.
Architecture Report — Fleet-Manager-API
Generated: 2023-10-27
Seniority level: Senior
1. Project Overview
A distributed fleet management system for real-time vehicle tracking and dispatching. It handles high-throughput telemetry data and manages driver-to-vehicle assignments.
2. Technology Stack
| technology | version | purpose | why chosen |
|---|---|---|---|
| Go | 1.21 | Backend services | Concurrency and performance |
| PostgreSQL | 15 | Persistent storage | Relational integrity |
| Redis | 7.0 | Caching & Pub/Sub | Low-latency state sync |
| gRPC | 1.58 | Inter-service communication | Type safety and performance |
3. High-Level Architecture
[API Gateway] -> [Auth Service]
|
+-> [Vehicle Service] <-> [Telemetry Service] -> [Redis]
| |
+-> [Driver Service] <--- [PostgreSQL]
The system follows a microservices pattern with gRPC for synchronous calls and Redis for async state updates.
4. Module Breakdown
Vehicle Service
- Purpose: Manages vehicle lifecycle and metadata.
- Structure: Handler -> Service -> Repository (Clean Architecture).
Key files: cmd/server/main.go (entry), internal/domain/vehicle.go (models), internal/service/manager.go (logic).
- External calls: Calls Auth Service for JWT validation; publishes updates to Redis.
7. End-to-End Request Flow: Update Vehicle Location
POST /v1/telemetry->gateway/router.go- Gateway ->
telemetry/handler.go:UpdateLocation - Handler ->
telemetry/service.go:Process(validates bounds) - Service ->
telemetry/repo.go:Save(writes to Postgres) - Service ->
redis/pub.go:Publish(notifies tracking UI)
10. Potential Pain Points
- Database Coupling: The
DriverandVehicleservices share the same Postgres instance, risking contention. - Synchronous Bottleneck: Gateway waits on Auth gRPC synchronously; consider local JWT caching.
Next steps
- Review the
docs/architecture.mdfor the full data model and ASCII ERD. - Ask me to trace the "Driver Onboarding" flow.
- Request a deep dive into the Redis Pub/Sub implementation.
Connects securely to your tools. The creator never sees your data.
About this skill
Understanding a new codebase takes days. This skill asks your seniority first, so a beginner gets analogies and a senior gets trade-offs and pain points, then explores the project (sequentially or with parallel subagents, one per module) and writes a standard ten-section report: overview, stack, high-level architecture with an ASCII diagram, module breakdown, cross-cutting concerns, data model, one traced end-to-end request, design patterns, non-obvious conventions and potential pain points.
Works on any stack: web, backend, mobile, CLI and monorepos.
Example prompts
- "Explain the architecture of this project"
- "Walk me through the code"
- "Generate an architecture report"
Find more skills like this on the Claude Skills Marketplace, the Codex Skills Marketplace and the Gemini Skills Marketplace, or browse Claude Skills for Technical Documentation.
Requires a model capable of subagent delegation for large projects. ASCII diagrams are simplified representations. Output is written to a local docs folder.
How to use
- 1
Connect your agent to the Agensi MCP
Copy the prompt and paste it into Claude, ChatGPT, Cursor or any agent that supports MCP. It sets up the connection for you. Manual setup
- 2
Sign in to Agensi
Your agent shows a sign-in link. Sign in and click Allow.
- 3
Ask for what you need
Your agent loads this skill and uses it on your task. It always asks before buying a skill.
Reviews
No reviews yet
Be one of the first to try it. Every listed skill goes through the trust checks below.
Security scanned
Checked by our 8-point scan before listing
Fresh listing
Recently published to Agensi
Free to use
No account required to browse
Trust & safety
Security scan
Security scan passed 17 days ago
- Free with an Agensi account