Architecture Decision Records
This section contains Architecture Decision Records (ADRs) documenting the significant architectural decisions made during the development of Curriculum Curator.
What are ADRs?
Architecture Decision Records are documents that capture important architectural decisions made along with their context and consequences. Each ADR describes a choice the team made and why that choice was made.
Why do we use ADRs?
ADRs help us:
- Document important decisions for future reference
- Communicate the reasoning behind choices to new team members
- Track the evolution of the system architecture over time
- Provide context for current design decisions
Available ADRs
Here are the current ADRs for the Curriculum Curator project:
| ADR | Title | Status |
|---|---|---|
| ADR-0001 | Record Architecture Decisions | Accepted |
| ADR-0002 | Validation and Remediation Design | Accepted |
| ADR-0003 | Workflow Configuration Format | Accepted |
| ADR-0004 | Interactive Workflow Builder | Accepted |
| ADR-0005 | Interactive Interfaces | Accepted |
ADR Process
- Proposal: When a significant architectural decision needs to be made, an ADR is drafted
- Discussion: The team discusses the proposed ADR
- Acceptance: Once consensus is reached, the ADR is accepted
- Implementation: The decision is implemented in the codebase
- Review: ADRs can be reviewed and updated as the system evolves
ADR Template
When creating a new ADR, use the template as a starting point.