ADR-001: Example Architecture Decision Record
Status: Proposed Date: 2025-12-02 Deciders: Team Tags: adr example documentation
Context
This is an example ADR to demonstrate the format and structure. You can use this as a reference when creating your first real ADR for Hollowgate.
In a real ADR, you would describe the problem or challenge you’re facing. For example: “We need to choose a game engine for Hollowgate that supports our vision of [describe game vision].”
Decision
This is where you state the decision clearly. For example: “We will use Unreal Engine 5 for the Hollowgate project.”
Consequences
Positive
- Clear documentation format established
- Team has a template to follow
- Historical record of decisions
Negative
- Requires discipline to maintain
- Takes time to write thorough ADRs
Neutral
- ADRs become part of our workflow
- Living documentation that evolves
Alternatives Considered
Option 1: No formal documentation
- Pros: Faster initial development
- Cons: Lost context over time, harder onboarding
- Why not chosen: Long-term maintenance and team growth require documentation
Option 2: Wiki-style documentation
- Pros: More flexible format
- Cons: Less structured, harder to track decision evolution
- Why not chosen: ADRs provide better structure for decisions
Implementation Notes
- Use the template in
../Templates/ADR-Template.md - Number ADRs sequentially starting from 001
- Keep ADRs focused on single decisions
- Update the index in ADRs/README.md
References
- ADR concept: https://adr.github.io/
- Related RFCs: See ../RFCs/README.md