Skip to main content

Understanding Revisions in Architect

Welcome to the guide on working with revisions in the Architect tool. Revisions are a cornerstone of how Architect helps you manage, evolve, and apply changes to your software's architecture in a structured and traceable manner.

What are Revisions?​

In Architect, a "revision" represents a set of proposed architectural changes. Think of it as a blueprint or a changeset that describes modifications to your system's components, such as adding new API endpoints, defining domain events, or updating data models.

These revisions are typically defined in a JSON format (e.g., revisions.json) and contain a list of ComponentOperation objects. Each operation specifies an action (like CREATE, UPDATE, DELETE) to be performed on a particular component.

Why are Revisions Important?​

  • Structured Changes: Revisions provide a formal way to define and review architectural modifications before they are applied.
  • Traceability: They offer a history of how your system's architecture has evolved over time.
  • Automation: Architect can process these revision files to automate parts of the code generation or update process.
  • Collaboration: They facilitate discussion and collaboration among team members on proposed architectural changes.
  • LLM Integration: Revisions can be generated or refined with the assistance of Large Language Models (LLMs) by providing them with your project's context.

Next Steps​

In the following guides, we'll delve deeper into:

  • Creating Revision Drafts
  • Understanding Component Operations
  • Applying Revisions