Architecture decision records (ADR) in Microservices - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the code to define the main purpose of an ADR.

Microservices

An ADR is a document that captures the [1] made during a software architecture process.

Drag options to blanks, or click blank then click option'

Aerrors

Bbugs

Cdecisions

Dfeatures

Attempts:

3 left

💡 Hint

Common Mistakes

Confusing decisions with bugs or errors.

An ADR records architectural decisions to keep track of why and how choices were made.

2fill in blank

medium

Complete the code to show what an ADR typically includes.

Microservices

An ADR usually contains the context, the decision, and the [1] of that decision.

Drag options to blanks, or click blank then click option'

Atests

Bcode

Cbugs

Dconsequences

Attempts:

3 left

💡 Hint

Common Mistakes

Choosing code or tests instead of consequences.

The ADR explains the consequences of the decision to understand its impact.

3fill in blank

hard

Fix the error in the ADR filename format.

Microservices

The ADR filename should be like '[1]-short-title.md' to keep files ordered and clear.

Drag options to blanks, or click blank then click option'

Adoc

B001

Ctitle

Ddecision

Attempts:

3 left

💡 Hint

Common Mistakes

Using words instead of numbers for ordering.

Using a number like 001 at the start keeps ADR files in order.

4fill in blank

hard

Fill both blanks to complete the ADR creation command and file extension.

Microservices

To create a new ADR, run 'adr [1]' and save it as '[2]'.

Drag options to blanks, or click blank then click option'

Anew

Bupdate

C.md

D.txt

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'update' command or '.txt' extension.

The command new creates an ADR and the file is saved as a Markdown file .md.

5fill in blank

hard

Fill all three blanks to complete the ADR structure with title, status, and date.

Microservices

# [1]

Status: [2]

Date: [3]

Drag options to blanks, or click blank then click option'

ADecision to use microservices

BAccepted

C2024-06-01

DDraft

Attempts:

3 left

💡 Hint

Common Mistakes

Mixing up status and title or wrong date format.

The ADR starts with a title, then shows the status like 'Accepted', and the date it was made.

Practice

1. What is the main purpose of an Architecture Decision Record (ADR) in microservices projects?

easy

A. To document important architecture decisions and their reasons

B. To write detailed code for each microservice

C. To track bugs and issues in the system

D. To monitor server performance metrics

Solution

1. Step 1: Understand the role of ADRs

   ADRs are used to record key architecture decisions and why they were made.

2. Step 2: Differentiate ADRs from other documents

   ADRs are not for code, bugs, or performance monitoring but for decision documentation.

3. Final Answer:

   To document important architecture decisions and their reasons -> Option A

4. Quick Check:

   Purpose of ADR = Document decisions [OK]

Hint: ADRs capture decisions, not code or bugs [OK]

Common Mistakes:

• Confusing ADRs with bug tracking
• Thinking ADRs are code documentation
• Assuming ADRs monitor system metrics

2. Which of the following is the correct basic structure of an ADR document?

easy

A. Title, Status, Context, Decision, Consequences

B. Title, Code, Tests, Deployment, Logs

C. Summary, Bugs, Fixes, Performance, Metrics

D. Introduction, User Stories, UI Design, API Endpoints

Solution

1. Step 1: Recall ADR standard sections

   ADRs typically include Title, Status, Context, Decision, and Consequences.

2. Step 2: Eliminate unrelated structures

   Options with code, bugs, or UI design are unrelated to ADR format.

3. Final Answer:

   Title, Status, Context, Decision, Consequences -> Option A

4. Quick Check:

   ADR structure = Title, Status, Context, Decision, Consequences [OK]

Hint: Look for Context and Consequences in ADR structure [OK]

Common Mistakes:

• Mixing ADR with test or deployment docs
• Confusing ADR with bug reports
• Including UI design in ADR

3. Given this ADR excerpt:

Title: Use REST for service communication
Status: Accepted
Context: Need simple, stateless communication
Decision: Use REST over HTTP
Consequences: Easier integration but higher latency

What is the main consequence documented here?

medium

A. REST requires stateful connections for speed

B. REST causes stateless communication to fail

C. REST reduces integration complexity and latency

D. REST leads to easier integration but higher latency

Solution

1. Step 1: Read the Consequences section carefully

   The consequence states "Easier integration but higher latency".

2. Step 2: Match the consequence with options

   REST leads to easier integration but higher latency matches exactly; others contradict the text.

3. Final Answer:

   REST leads to easier integration but higher latency -> Option D

4. Quick Check:

   Consequence = Easier integration, higher latency [OK]

Hint: Focus on Consequences section for effects [OK]

Common Mistakes:

• Ignoring the 'higher latency' part
• Assuming REST reduces latency
• Confusing stateless with stateful

4. You find an ADR with this status:

Status: Deprecated

What does this status indicate about the decision?

medium

A. The decision is newly proposed and under review

B. The decision is no longer recommended or used

C. The decision is currently active and enforced

D. The decision has been accepted but not implemented yet

Solution

1. Step 1: Understand ADR status meanings

   "Deprecated" means the decision is outdated and should not be used.

2. Step 2: Compare with other statuses

   New proposals are "Proposed", active ones "Accepted", so deprecated means no longer recommended.

3. Final Answer:

   The decision is no longer recommended or used -> Option B

4. Quick Check:

   Status 'Deprecated' = Not recommended [OK]

Hint: Deprecated means outdated, avoid using [OK]

Common Mistakes:

• Confusing deprecated with accepted
• Thinking deprecated means new proposal
• Assuming deprecated means pending

5. Your team must decide between using REST or gRPC for microservice communication. You want to document this choice clearly for future reference. Which is the best way to use an ADR in this situation?

hard

A. Write code samples for both REST and gRPC without explanation

B. Skip documentation and decide by majority vote only

C. Write an ADR with Context explaining needs, Decision stating REST or gRPC, and Consequences of each choice

D. Create a bug report to track this decision

Solution

1. Step 1: Identify ADR purpose for decision documentation

   ADRs should explain context, decision, and consequences clearly.

2. Step 2: Evaluate options for documenting architecture choices

   Only Write an ADR with Context explaining needs, Decision stating REST or gRPC, and Consequences of each choice uses ADR properly; others ignore documentation or misuse formats.

3. Final Answer:

   Write an ADR with Context explaining needs, Decision stating REST or gRPC, and Consequences of each choice -> Option C

4. Quick Check:

   Use ADR to document decision and consequences [OK]

Hint: Use ADR to record context, decision, and consequences [OK]

Common Mistakes:

• Skipping documentation
• Confusing ADR with bug reports
• Only writing code without explanation