PromptSingle
VibeCodingMarch 19, 202612 viewsv1

Ernesto Lopez: Generate Complete ARCHITECTURE.md for Any Codebase

Generate a detailed ARCHITECTURE.md file that clarifies your codebase's structure, components, and integrations, enhancing team collaboration and project understanding.

Prompt Contentv1
Analyze this codebase and generate a comprehensive ARCHITECTURE.md file. Structure the document with these exact sections:

PROJECT STRUCTURE
Include a complete directory tree diagram showing all folders and files. Group by architectural layer or feature.

HIGH-LEVEL SYSTEM DIAGRAM
Provide a C4 Model Level 1 diagram or text-based block diagram showing: Users -> Frontend -> Backend -> Database and any external services/APIs.

CORE COMPONENTS
For each major component (Frontend, Backend Services, Microservices): describe purpose, technologies used, and deployment method.

DATA STORES
List all databases, caches, and message queues. For each: type (PostgreSQL, MongoDB, Redis, S3), purpose, and key schemas/collections.

EXTERNAL INTEGRATIONS
Every third-party API or service (Stripe, SendGrid, Firebase, etc). Include purpose and integration method.

DEPLOYMENT & INFRASTRUCTURE
Cloud provider, key services (EC2, Lambda, S3, RDS, Kubernetes), CI/CD pipeline, and monitoring tools.

SECURITY CONSIDERATIONS
Auth method (OAuth2, JWT, API Keys), authorization model, data encryption (TLS, at-rest), and security tools.

DEVELOPMENT & TESTING
Local setup instructions, testing frameworks, and code quality tools (ESLint, SonarQube, etc).

FUTURE CONSIDERATIONS
Known technical debt, planned migrations, and major features on the roadmap.

GLOSSARY
Define all project-specific acronyms and terms.

PROJECT IDENTIFICATION
Project name, repository URL, primary contact/team, and date of last update.

Like this prompt?

Create a free account to save, fork, and improve it with AI.

Get Started Free

Join PromptCentral — it's free

Start Free