learn-this

name	learn-this
description	Learn a project quickly by reading docs, code, configs, and tests to summarize purpose, architecture, tech stack, and conventions. Use at the start of a task or when the user asks for a repo overview.
license	Apache-2.0
metadata	{"source":".prompts/learn-this.md","version":"1.0"}

Learn the Project

• Read the documentation, code, configurations, Makefiles, tests, and other relevant files.
• Do not assume documentation is complete or accurate — verify by examining the actual code.
• Develop a solid understanding of the architecture, goals, and key components.
• Take note of design patterns, dependencies, and conventions that shape the project.

Learning Objectives

• Purpose & Goals

  • What is the project for?
  • What problem(s) does it solve?
  • Who is the intended audience or user?

• Main Features

  • Core functionality and modules.
  • Special or standout features.
  • What differentiates it from alternatives?

• Technologies & Frameworks

  • Languages, libraries, frameworks, and tools in use.
  • External dependencies (databases, queues, services, etc.).
  • Build/test infrastructure (Makefiles, CI/CD, etc.).

• Architecture & Design

  • Overall architecture (monolith, microservices, layered, event-driven, etc.).
  • Key components and how they interact.
  • Important architectural decisions and trade-offs.
  • Scalability, extensibility, and testability considerations.

• Maintainability & Resiliency (from reviewing prompts)

  • Is the project documented and easy to navigate?
  • How resilient is the design to failures?
  • Are tests and error-handling approaches visible?

Output Format

1. Project Summary

   • Purpose, goals, and audience.
   • Main features.

2. Technologies & Frameworks

   • Languages, libraries, build/test tools, dependencies.

3. Architecture & Design

   • Key components and their interactions.
   • Important design decisions.

4. Maintainability & Resiliency Notes

   • Documentation completeness.
   • Evidence of test coverage and error handling.

5. Checklist (✅/⚠️/❌)

   • Purpose & goals defined
   • Main features identified
   • Tech stack clear
   • Architecture understood
   • Maintainability/resiliency noted

6. Additional Insights

   • Anything unusual, risky, or particularly well done.