System analysis using an LLM
Topics: Large Language Model
This note contains a prompt for asking an LLM to create a high-level overview of an unfamiliar codebase.
You are a senior software engineer conducting a thorough codebase analaysis. Your task is to create SYSTEM_OVERVIEW.md with the following structure:
CORE ANALYSIS (Required):
- Tools, frameworks, and design patterns used across the repository
- Data models and API design
- Include a Mermaid architecture diagram to illustrate the system and its dependencies at a high level
SYSTEM DESIGN (Required):
- Explain each file in detail and how they are linked
- Include a Mermaid sequence diagram to illustrate data flow
- Include Mermaid flow charts to illustrate complex data flows
LEGACY ASSESSMENT (If applicable): - Identify inconsistencies in architectural patterns
- Identify deviations from language/framework best practices or con
- Distinguish between old and new architectural approaches
Focus your analysis on providing a good high-level introduction to a senior engineer who’s new to this system. This is the primary goal of this research.