InnerVault

Technical Codebase Discovery & Onboarding Prompt

Indexedprompts.chat (CC0 prompt collection), valdecir.carvalho@gmail.com

**Context:** I am a developer who has just joined the project and I am using you, an AI coding assistant, to gain a deep understanding of the existing codebase. My goal is to become productive as quickly as possible…

Open the source (opens github.com) https://github.com/f/prompts.chat

What it is

Prompts from valdecir.carvalho@gmail.com.

The problem it solves and who it suits haven't been reviewed by InnerVault. The description above is the source's own.

The prompt

**Context:**
I am a developer who has just joined the project and I am using you, an AI coding assistant, to gain a deep understanding of the existing codebase. My goal is to become productive as quickly as possible and to make informed technical decisions based on a solid understanding of the current system.

**Primary Objective:**
Analyze the source code provided in this project/workspace and generate a **detailed, clear, and well-structured Markdown document** that explains the system’s architecture, features, main flows, key components, and technology stack.
This document should serve as a **technical onboarding guide**.
Whenever possible, improve navigability by providing **direct links to relevant files, classes, and functions**, as well as code examples that help clarify the concepts.

---

## **Detailed Instructions — Please address the following points:**

### 1. **README / Instruction Files Summary**
- Look for files such as `README.md`, `LEIAME.md`, `CONTRIBUTING.md`, or similar documentation.
- Provide an objective yet detailed summary of the most relevant sections for a new developer, including:
  - Project overview
  - How to set up and run the system locally
  - Adopted standards and conventions
  - Contribution guidelines (if available)

---

### 2. **Detailed Technology Stack**
- Identify and list the complete technology stack used in the project:
  - Programming language(s), including versions when detectable (e.g., from `package.json`, `pom.xml`, `.tool-versions`, `requirements.txt`, `build.gradle`, etc.).
  - Main frameworks (backend, frontend, etc. — e.g., Spring Boot, .NET, React, Angular, Vue, Django, Rails).
  - Database(s):
    - Type (SQL / NoSQL)
    - Name (PostgreSQL, MongoDB, etc.)
  - Core architecture style (e.g., Monolith, Microservices, Serverless, MVC, MVVM, Clean Architecture).
  - Cloud platform (if identifiable via SDKs or configuration — AWS, Azure, GCP).
  - Build tools and package managers (Maven, Gradle, npm, yarn, pip).
  - Any other relevant technologies (caching, message brokers, containerization — Docker, Kubernetes).
- **Reference and link the configuration files that demonstrate each item.**

---

### 3. **System Overview and Purpose**
- Clearly describe what the system does and who it is for.
- What problems does it solve?
- List the core functionalities.
- If possible, relate the system to the business domains involved.
- Provide a high-level description of the main features.

---

### 4. **Project Structure and Reading Recommendations**
- **Entry Point:**
  Where should I start exploring the code? Identify the main entry points (e.g., `main.go`, `index.js`, `Program.cs`, `app.py`, `Application.java`).
  **Provide direct links to these files.**
- **General Organization:**
  Explain the overall folder and file structure. Highlight important conventions.
  **Use real folder and file name examples.**
- **Configuration:**
  Are there main configuration files? (e.g., `config.yaml`, `.env`, `appsettings.json`)
  Which configurations are critical?
  **Provide links.**
- **Reading Recommendation:**
  Suggest an order or a set of key files/modules that should be read first to quickly grasp the project’s core concepts.

---

### 5. **Key Components**
- Identify and describe the most important or central modules, classes, functions, or services.
- Explain the responsibilities of each component.
- Describe their responsibilities and interdependencies.
- For each component:
  - Include a representative code snippet
  - Provide a link to where it is implemented
- **Provide direct links and code examples whenever possible.**

---

### 6. **Execution and Data Flows**
- Describe the most common or critical workflows or business processes (e.g., order processing, user authentication).
- Explain how data flows through the system:
  - Where data is persisted
  - How it is read, modified, and propagated
- **Whenever possible, illustrate with examples and link to relevant functions or classes.**

#### 6.1 **Database Schema Overview (if applicable)**
- For data-intensive applications:
  - Identify the main entities/tables/collections
  - Describe their primary relationships
  - Base this on ORM models, migrations, or schema files if available

---

### 7. **Dependencies and Integrations**
- **Dependencies:**
  List the main external libraries, frameworks, and SDKs used.
  Briefly explain the role of each one.
  **Provide links to where they are configured or most commonly used.**
- **Integrations:**
  Identify and explain integrations with external services, additional databases, third-party APIs, message brokers, etc.
  How does communication occur?
  **Point to the modules/classes responsible and include links.**

#### 7.1 **API Documentation (if applicable)**
- If the project exposes APIs:
  - Is there evidence of API documentation tools or standards (e.g., Swagger/OpenAPI, Javadoc, endpoint-specific docstrings)?
  - Where can this documentation be found or how can it be generated?

---

### 8. **Diagrams**
- Generate high-level diagrams to visualize the system architecture and behavior:
  - Component diagram (highlighting main modules and their interactions)
  - Data flow diagram (showing how information moves through the system)
  - Class diagram (showing key classes and relationships, if applicable)
  - Simplified deployment diagram (where components run, if detectable)
  - Simplified infrastructure/deployment diagram (if infrastructure details are apparent)
- **Create these diagrams using Mermaid syntax inside the Markdown file.**
- Diagrams should be **high-level**; extensive detailing is not required.

---

### 9. **Testing**
- Are there automated tests?
  - Unit tests
  - Integration tests
  - End-to-end (E2E) tests
- Where are they located in the project?
- Which testing framework(s) are used?
- How are tests typically executed?
- How can tests be run locally?
- Is there any CI/CD strategy involving tests?

---

### 10. **Error Handling and…

Written by the prompts.chat (CC0 prompt collection) community (valdecir.carvalho@gmail.com). Not tested by InnerVault.

How to get it

Setup steps: not applicable.

Related

  1. You are a senior software architect specializing in codebase health and technical debt elimination. Your task is to conduct a surgical dead-code audit — not just detect, but triage and prescribe…

    Indexed prompts.chat (CC0 prompt collection), ersinkoc CC0-1.0

  2. I want you to act as a Senior Software Engineer performing a rigorous code quality, maintainability, and technical debt audit on a codebase. Your objective is to aggressively yet safely simplify the codebase, improve…

    Indexed prompts.chat (CC0 prompt collection), Prakritsigdel CC0-1.0

  3. Translate dense engineering jargon, RFCs, or whitepapers into plain language

    Indexed prompts.chat (CC0 prompt collection), manjunath.vr@gmail.com CC0-1.0

  4. Perform a technical analysis of the outlined project. Analyze: - Technical requirements and dependencies - Architecture considerations - Potential technical challenges - Required tools and technologies - Performance…

    Indexed prompts.chat (CC0 prompt collection), f CC0-1.0

  5. --- name: prd-and-technical-documentation-generator description: A skill for generating comprehensive Product Requirements Documents (PRDs) and technical documentation for projects. --- # PRD and Technical…

    Indexed prompts.chat (CC0 prompt collection), tcyjg CC0-1.0

  6. # ========================================================== # Prompt Name: Non-Technical IT Help & Clarity Assistant # Author: Scott M # Version: 1.5 (Multi-turn optimized, updated recommendations & instructions…

    Indexed prompts.chat (CC0 prompt collection), thanos0000@gmail.com CC0-1.0