Readied Docs

Architecture Decision Records

Significant architectural decisions made during Readied's development

Architecture Decision Records

This section documents significant architectural decisions made during Readied's development.

What is an ADR?

An Architecture Decision Record (ADR) captures a single architectural decision along with its context and consequences. ADRs help future maintainers understand why decisions were made.

ADR Index

ADRTitleStatus
ADR-001Runtime ContractAccepted
ADR-002Markdown ModelAccepted
ADR-003Storage StrategyAccepted

ADR Template

When adding a new ADR, use this template:

# ADR-XXX: [Title]

## Status

Accepted | Superseded | Deprecated

## Context

What problem are we solving?

## Decision

What did we decide?

## Consequences

### Positive

- ...

### Negative

- ...

### Risks

- ...

## Alternatives Considered

1. Option A — rejected because...
2. Option B — rejected because...

Principles for ADRs

  1. One decision per ADR - Keep them focused
  2. Immutable once accepted - Create new ADR to supersede
  3. Include context - Future you won't remember why
  4. Document alternatives - Show due diligence