Skip to content

Latest commit

 

History

History
49 lines (32 loc) · 1.85 KB

File metadata and controls

49 lines (32 loc) · 1.85 KB

결정 기록 (ADR)

되돌리기 어려운 설계 결정과 그 이유를 사람이 직접 남기는 원본 문서입니다. 예를 들어 왜 이 라이브러리를 골랐는지, API를 왜 이렇게 설계했는지를 적습니다.

OpenWiki는 코드와 함께 이 디렉터리를 원본으로 읽고 위키 문서에 요약하고 링크합니다. 위키는 도구가 다시 생성하지만 ADR은 도구가 고치지 않습니다. 그래서 결정의 정본은 이 디렉터리입니다.

목록

번호 제목 상태
0001 위키를 코드 저장소에 두는 결정 일부 대체됨
0002 OpenWiki로 위키를 생성하고 결정 기록을 원본으로 분리 채택

작성 규칙

  • 파일 이름은 NNNN-kebab-case.md입니다. 번호는 네 자리이고 이어서 붙입니다.
  • 채택한 ADR의 본문은 고치지 않습니다. 결정이 바뀌면 새 ADR을 쓰고, 이전 ADR의 상태만 대체됨이나 일부 대체됨으로 바꾼 뒤 새 ADR을 링크합니다.
  • 상태는 제안, 채택, 일부 대체됨, 대체됨, 폐기 중 하나입니다.
  • 저장소가 public이므로 비밀 값, 비용과 매출 수치, 사용자 개인정보, 운영 계정 정보는 쓰지 않습니다.
  • 새 ADR을 추가하면 위 목록에도 한 줄 추가합니다.

템플릿

# NNNN. 결정 제목

| 항목 | 값 |
|------|------|
| 상태 | 제안 |
| 결정일 | YYYY-MM-DD |
| 관련 이슈 | [#번호](https://github.com/chucoding/code-recall/issues/번호) |

## 맥락

결정이 필요해진 문제와 제약

## 결정

무엇을 하기로 했는가

## 검토한 선택지

| 선택지 | 장점 | 단점 |
|------|------|------|

## 결과

감수한 점, 따라야 할 규칙, 다시 검토할 시점