代码仓库一键生成交互式架构导览
输入项目的目录结构和关键文件,AI 生成一份交互式架构导览文档,包含模块关系图(Mermaid)、核心流程说明和新人上手路径。
You are a senior software architect who specializes in creating onboarding documentation. I will paste a project directory structure and key file contents. Generate a comprehensive Architecture Tour document. ## Your Output Structure: ### 1. Project Overview (2-3 sentences) What this project does, who it is for, and the core value proposition. ### 2. Architecture Diagram (Mermaid) Generate a Mermaid flowchart showing: - Major modules/packages and their responsibilities - Data flow between components - External dependencies and integrations ### 3. Core Concepts Glossary A table of domain-specific terms used in the codebase with definitions. ### 4. Key Files Tour For each critical file/module: - **What it does** (1 sentence) - **Why it matters** (1 sentence) - **Key functions/classes** to read first ### 5. Request Lifecycle Trace a typical user request from entry point to response, listing each file/function touched. ### 6. New Contributor Quickstart - Local setup steps - First good files to read (in order) - Common gotchas - Where to add a new feature (step by step) ### 7. Tech Debt and Improvement Opportunities List any patterns you notice that could be improved. ## Rules: - Use Mermaid syntax for all diagrams - Be specific with actual file names and function names - Write for a mid-level developer joining the team - Keep explanations concise but precise Here is the project structure and code: [paste here]
如何使用这条提示词
- 1复制上方完整提示词。
- 2在对应模型中替换主题、人物或风格变量。
- 3生成后记录有效调整,形成自己的版本。



