AI Coding Agents & Rules
Target: Claude Code, Cursor, Windsurf, Cline, ChatGPT

Multi-File Codebase Exploration & Architectural Onboarding

Prompt an agent to analyze an unfamiliar codebase and deliver an architectural breakdown, data flows, and gotchas.

OnboardingArchitectureAI AgentsCodebaseDocumentation

Interactive Prompt Playground

Customize Template Fields
Live replacement
{{ENTRY_POINTS}}
{{REPO_CONTEXT}}
Rendered Prompt (Ready to paste)1259 characters
You are a Principal Software Architect onboarding to a new, unfamiliar codebase.

Explore and analyze the codebase to produce an Architectural Onboarding Brief:

Entry Points / Key Files to Inspect:
```
package.json, app/layout.tsx, lib/, workers/
```

Repository Context: Developer productivity web platform with Next.js frontend and Cloudflare Worker real-time rooms

Analyze the codebase and deliver a clear onboarding briefing:
1. **High-Level System Architecture**:
   - Tech stack, runtime frameworks, and build tooling.
   - Core directory breakdown and responsibilities.
2. **Primary Data & Request Flows**:
   - Trace a typical request from entry point (HTTP / CLI / Event) through the middleware, business services, and database layers.
3. **State Management & Data Persistence**:
   - How is persistent and ephemeral state handled (Databases, ORM, Caching, Client State)?
4. **Key Design Patterns & Conventions**:
   - Recurring architectural idioms, error handling strategies, and dependency injection patterns.
5. **Gotchas, Traps & Non-Obvious Quirks**:
   - Undocumented conventions, brittle configurations, or non-standard patterns every developer must know.
6. **Suggested Next Steps**:
   - 3 recommended starting tasks to build familiarity.

How to Use This Prompt

  1. Point your coding agent at entry-point files in your repository.
  2. Receive a structured architecture briefing and developer gotchas guide.

Engineering Tips & Best Practices

  • Save the output as ARCHITECTURE.md in your repository root to accelerate future team onboarding.

What This Prompt Inspects

Key failure modes, design principles, and quality standards evaluated during execution.

End-to-End Request Trace

Traces real data flows from ingress to database.

Gotcha Detection

Highlights non-standard configurations before developers break them.

Actionable Next Steps

Provides a practical on-ramp for new engineers joining the team.

SprintKit Workflow Integrations

Complementary interactive tools and workflows across SprintKit to accelerate your engineering process.

Related Prompts

Explore related developer prompts in this workflow domain.

All Prompts

Technical Design Document (RFC) Generator

Generate thorough, engineering-ready Request for Comments (RFC) and Architecture Decision Records (ADRs).

ArchitectureRFCADRPlanning+1
3 variablesCustomize prompt

Cursor & Windsurf Rules Generator (.cursorrules / .windsurfrules)

Generate a custom, context-rich project rules file that stops AI coding agents from making recurring mistakes.

CursorWindsurfAI AgentsCoding Agents+1
3 variablesCustomize prompt

Microservices Boundary & Domain-Driven Design Decomposition

Deconstruct monoliths or complex systems into bounded contexts with clear domain events and data ownership.

MicroservicesDDDArchitectureSystem Design
2 variablesCustomize prompt