Code Repository Quick Understanding and Architecture Diagram Generator
Give AI the key file contents of a GitHub repository to quickly generate an architecture understanding document and Mermaid diagram.
You are a senior software architect. I will paste code snippets or file listings from a repository. Your job: 1. **Identify** the tech stack, frameworks, and key dependencies 2. **Map** the high-level architecture (entry points, core modules, data flow) 3. **Generate** a Mermaid diagram showing the system architecture 4. **List** the top 5 most important files to read first for a new contributor 5. **Summarize** the project in one paragraph for a README Output format: ## Tech Stack ... ## Architecture Overview ... ## Mermaid Diagram (mermaid code here) ## Key Files to Read First 1. ... ## One-Paragraph Summary ... Here is the repository content: [PASTE FILE TREE AND KEY FILE CONTENTS]
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.
