Skip to content

personal-cpa/adr

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

2 Commits
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“˜ Architecture Decision Records (ADR)

🧭 λͺ©μ  (Purpose)

이 λ¦¬ν¬μ§€ν† λ¦¬λŠ” 우리 νŒ€μ˜ 기술적 μ•„ν‚€ν…μ²˜ 결정을 κΈ°λ‘ν•˜κΈ° μœ„ν•΄ μ‘΄μž¬ν•©λ‹ˆλ‹€. λͺ¨λ“  μ€‘μš”ν•œ 기술 결정은 κ·Έ λ‹Ήμ‹œμ˜ λ§₯락, κ³ λ €ν–ˆλ˜ λŒ€μ•ˆ, κ·Όκ±°, κ²°κ³Ό 등을 λ¬Έμ„œν™”ν•˜μ—¬ 지속 κ°€λŠ₯ν•œ ν˜‘μ—…, λΉ λ₯Έ μ˜¨λ³΄λ”©, μΌκ΄€λœ 기술 νŒλ‹¨μ„ κ°€λŠ₯ν•˜κ²Œ ν•©λ‹ˆλ‹€.

πŸ“š ADRμ΄λž€?

ADR (Architecture Decision Record) λŠ” νŠΉμ • 기술적 λ¬Έμ œμ— λŒ€ν•΄ 무엇을, μ™œ, μ–΄λ–»κ²Œ κ²°μ •ν–ˆλŠ”μ§€λ₯Ό κΈ°λ‘ν•˜λŠ” λ¬Έμ„œμž…λ‹ˆλ‹€. μ§§κ³  λͺ…ν™•ν•œ λ¬Έμ„œλ‘œ, 이후에 νŒ€μ›λ“€μ΄ 같은 결정을 λ°˜λ³΅ν•˜κ±°λ‚˜ μ§ˆλ¬Έν•˜μ§€ μ•Šλ„λ‘ λ„μ™€μ€λ‹ˆλ‹€.

μ°Έκ³ : Architecture Decision Record

πŸ”– ADR λͺ©λ‘

번호 제λͺ© μƒνƒœ μš”μ•½
ADR-001 Deprecate cron in favor of scheduler πŸ” Superseded cron λŒ€μ‹  Airflow둜 μ „ν™˜
ADR-002 Use Airflow for DAG orchestration βœ… Accepted μ›Œν¬ν”Œλ‘œμš° λ„κ΅¬λ‘œ Airflow 채택
ADR-003 Adopt batch processing for ETL 🟑 Proposed 배치 기반 νŒŒμ΄ν”„λΌμΈ 선택

μƒˆλ‘œμš΄ ADR을 μž‘μ„±ν•˜λ©΄ 이 ν‘œμ—λ„ μΆ”κ°€ν•΄μ£Όμ„Έμš”. (μƒνƒœ 이λͺ¨μ§€λŠ” λ³€κ²½ κ°€λŠ₯)

πŸ› οΈ μž‘μ„± 및 μ‚¬μš©λ²•

πŸ“ 디렉토리 ꡬ쑰

/adr
  β”œβ”€β”€ docs
    β”œβ”€β”€ adr-001-deprecate-cron.md
    β”œβ”€β”€ adr-002-use-airflow-for-dag-orchestration.md
    β”œβ”€β”€ adr-003-adopt-batch-processing.md
  β”œβ”€β”€ template
    β”œβ”€β”€ ADR-000-template.md

🧱 파일 μž‘λͺ… κ·œμΉ™

  • adr-XXX-short-title.md ν˜•μ‹ (λ²ˆν˜ΈλŠ” 순차적으둜 증가)
  • 제λͺ©μ€ [Verb + λŒ€μƒ + λ§₯락] ν˜•μ‹μœΌλ‘œ 짧게

μ˜ˆμ‹œ:

  • adr-004-adopt-prefect-for-orchestration.md

βœ… μƒνƒœ 관리

  • 🟑 Proposed: μ œμ•ˆλœ μƒνƒœ, 아직 κ²€ν†  쀑
  • βœ… Accepted: 채택됨, μ‹€ν–‰ μ€‘μ΄κ±°λ‚˜ μ™„λ£Œλ¨
  • ❌ Rejected: κ²€ν† λ˜μ—ˆμ§€λ§Œ μ±„νƒλ˜μ§€ μ•ŠμŒ
  • πŸ” Superseded: λ‹€λ₯Έ 결정에 μ˜ν•΄ λŒ€μ²΄λ¨

✍️ ν…œν”Œλ¦Ώ

template.mdλ₯Ό 볡사해 μƒˆ ADR을 μž‘μ„±ν•˜μ„Έμš”. 각 ν•­λͺ©μ— λŒ€ν•΄ λ‹€μŒκ³Ό 같은 μ§ˆλ¬Έμ— λ‹΅ν•˜λ©° μž‘μ„±ν•©λ‹ˆλ‹€:

ν•­λͺ© 질문
Context μ™œ 이 결정이 ν•„μš”ν•œκ°€? μ–΄λ–€ λ¬Έμ œκ°€ μžˆμ—ˆλ‚˜?
Decision μš°λ¦¬λŠ” 무엇을 κ²°μ •ν–ˆλŠ”κ°€?
Alternatives λ‹€λ₯Έ λŒ€μ•ˆμ€ 무엇이 μžˆμ—ˆκ³ , μ™œ μ„ νƒν•˜μ§€ μ•Šμ•˜λ‚˜?
Rationale 이 선택이 κ°€μž₯ μ ν•©ν•˜λ‹€κ³  νŒλ‹¨ν•œ μ΄μœ λŠ”?
Consequences 이 κ²°μ •μœΌλ‘œ 인해 λ°œμƒν•  영ν–₯은?
Related Decisions κ΄€λ ¨λœ λ‹€λ₯Έ ADR이 μžˆλŠ”κ°€?
References μ°Έκ³ ν•œ λ¬Έμ„œ, 회의 기둝 등은?

πŸ§ͺ μ˜ˆμ‹œ λ¬Έμ„œ

{TBD}

🀝 κΈ°μ—¬ κ°€μ΄λ“œ

  • μƒˆ ADR을 μž‘μ„±ν•  경우 template.mdλ₯Ό 볡사해 번호λ₯Ό λΆ™μ΄μ„Έμš”.
  • νŒ€ λ‚΄μ—μ„œ λ…Όμ˜ ν›„ Statusλ₯Ό Accepted둜 λ°”κΎΈμ–΄ λ³‘ν•©ν•©λ‹ˆλ‹€.
  • κΈ°μ‘΄ ADR을 λŒ€μ²΄ν•  경우, README.md의 ADR λͺ©λ‘μ˜ μƒνƒœλ₯Ό πŸ” Superseded둜 λ³€κ²½ν•˜μ„Έμš”.
  • λ°˜λ“œμ‹œ μœ„ ADR λͺ©λ‘μ—λ„ ν•­λͺ©μ„ μΆ”κ°€ν•˜μ„Έμš”.

🧠 β€œκΈ°μ–΅μ€ νλ €μ§€μ§€λ§Œ, 기둝은 λ‚¨λŠ”λ‹€.” β€” μ˜μ‚¬κ²°μ •μ„ 미래의 νŒ€μ›μ—κ²Œ μ„ λ¬Όν•˜μ„Έμš”.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors