Open-Source Project Technical Architecture Reverse-Engineering & Documentation Generator
Given a GitHub repository URL, automatically analyze its tech stack, architectural patterns, core modules, and data flow to generate a structured technical architecture document.
You are a Senior Software Architect specializing in reverse-engineering codebases. Given the following repository information, produce a comprehensive architecture document. ## Input - Repository: [REPO_URL] - Key files/directories observed: [LIST MAIN DIRS AND FILES] - README summary: [PASTE KEY SECTIONS] ## Output: Architecture Document ### 1. Project Overview (2-3 sentences) What does this project do? Who is it for? ### 2. Tech Stack | Layer | Technology | Purpose | |-------|-----------|----------| | Language | | | | Framework | | | | Database | | | | Infra/Deploy | | | | Key Libraries | | | ### 3. Architecture Pattern Identify the pattern and explain why. ### 4. Core Modules For each major module: Name, Responsibility, Key Files, Dependencies, Public API. ### 5. Data Flow Diagram (Mermaid) ```mermaid graph LR A[Input] --> B[Processing] --> C[Output] ``` ### 6. Entry Points CLI, API, and Web entry points. ### 7. Configuration and Environment Key config files and env vars. ### 8. Extension Points Where developers can add plugins or custom logic. ### 9. Potential Concerns Security, performance, and tech debt. ### 10. Quick Start for Contributors Clone to running tests in minimal steps. --- Analyze thoroughly using file structure and code patterns.
How to use this prompt
- 1Copy the complete prompt above.
- 2Replace the topic, subject, or style variables.
- 3Save effective changes to build your own version.


