ADR 작성 방법 - linewalks/dev-common GitHub Wiki

ADRs(Architecture Decision Records)

  • 아키텍처적인 결정에 대한 기록
    • 제안 이유
    • 결정 이유
    • 결과

왜 작성해야하는가

  • 미래의 당신을 위해
  • 당신의 동료를 위해
  • 미래의 동료를 위해

작성 위치

전체 개발 관련

포지션별

프로젝트별

  • 프로젝트에 따라
    • yona 게시판
    • github wiki
yona 사용시
  • 제목 태그 사용
    • [ADR]
    • [상태] (Accepted, Rejected 등)
    • [기능 이름] (프로젝트에서 사용하는 용어)
    • [기술 이름] (celery 등, 필요시)

작성 방법

  • 언어

    • 한국어
    • 단어만 영어 허용

  • 문투

    • 1순위: 술어 없이
      • ~~로 결정
      • ~~ 요청
    • 2순위: ~음 (1순위로 해결안되는 것들)
      • ~~로 결정함
      • ~~ 요청함

  • 항목

    • 날짜 YYYY-MM-DD
    • Status
      • Proposed 제안됨 (논의 진행 중)
      • Accepted 제안 수용됨
      • Deprecated 더 이상 사용하지 않지만, 기존 코드에 남아 있을수 있음
      • Superceded 대체됨
    • Context
      • 제안 이유
    • Decision
      • 결정 사항 (어떤 이유로 결정했는지)
    • Consequences
      • 결정에 따라
        • 어떻게 수정해야하는지
        • 어떤 영향이 있는지
        • 누가 작업해야하는지
    • References
      • 참조할 링크 (이슈, 문서, 외부 등등)

References

(Github Blog) Why Write ADRs