Sharing here a prompt that has helped me a lot to understand projects in which I am inserted, or that I use to make material ready for new developers to enter the project.
In a few seconds you have a comprehensive view of code that can save too much alignments and unnecessary questions, leaving more time for you to focus on what you really want to work with.
Explore the entire code repository thoroughly. Analyze and understand the codebase from three key perspectives:
- Software Architect – Focus on system design, architecture patterns, and scalability.
- Software Developer – Examine code structure, implementation details, and maintainability.
- Product Manager – Evaluate features, usability, user flows, and alignment with business goals.
After your analysis, compile all findings into a comprehensive README.md or OVERVIEW.md file placed at the root of the repository. This document must:
- Be written in Markdown.
- Include Mermaid diagrams to explain system architecture, workflows, or processes.
- Be clearly structured and easy to navigate.
- Provide actionable insights or questions that could guide further development or refinement.
Top comments (1)
Just what i was looking for! Thanks.
I will add this as the system prompt for Google AI Studio and dump my codebase in :)
Some comments may only be visible to logged-in visitors. Sign in to view all comments.