engineer-assessment/DECISIONS.md.example at master · lawnstarter/engineer-assessment · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# Architectural Decisions

Document your key architectural decisions here. For each major decision, explain your reasoning, the alternatives you considered, and the trade-offs you accepted.

## Template

For each decision, use this format:

```markdown
## Decision: [Title]

**Context:**
What problem were you solving? What constraints did you face?

**Options Considered:**
1. **Option A** - Brief description
   - Pros: ...
   - Cons: ...
2. **Option B** - Brief description
   - Pros: ...
   - Cons: ...

**Decision:**
What you chose and why

**Consequences:**
Trade-offs you accepted, technical debt incurred, or future considerations
```

---

## Example

**Context:**
Needed to store Star Wars data from SWAPI with relationships between people and films while supporting efficient queries for search and statistics.

**Options Considered:**
1. **Normalized relational schema with pivot tables**
   - Pros: Data integrity, efficient queries, supports complex relationships
   - Cons: More tables to manage, requires joins
2. **JSON columns for related data**
   - Pros: Simpler schema, fewer tables
   - Cons: Harder to query relationships, potential data duplication

**Decision:**
Chose normalized relational schema...

**Consequences:**
...

---

## Your Decisions

Replace the example above with your actual decisions. Aim for 3-5 decisions that showcase your architectural thinking.