아키텍처 의사결정 기록(ADR) 템플릿

이것은 EdgeX Foundry ADR을 위한 템플릿입니다.

출처: https://docs.edgexfoundry.org/2.3/design/adr/template/

제출자

ADR 제출자를 나열하십시오.

형식:

• 이름(조직)

변경 로그

상태, 날짜, PR URL을 포함하여 문서의 변경 사항을 나열하십시오.

상태는 다음 중 하나입니다: pending, approved, amended, deprecated.

날짜는 ISO 8601(YYYY-MM-DD) 문자열입니다.

PR은 변경을 제출한 풀 리퀘스트이며, diff, 기여자, 검토자 같은 정보를 포함합니다.

형식:

• [ADR의 상태, 예: approved, amended 등](풀 리퀘스트 URL) YYYY-MM-DD

참조하는 사용 사례

관련된 모든 사용 사례 / 요구사항 문서를 나열하십시오.

ADR에는 관련되고 승인된 사용 사례가 최소 하나 필요합니다.

형식:

• [사용 사례 이름](URL)

ADR이 사용 사례의 모든 요구사항을 다루지 않는 경우 설명을 추가하십시오.

맥락

다음을 설명하십시오:

• 설계가 아키텍처상 어떻게 중요한지 - ADR이 필요한 이유(문제를 해결하기 위한 단순한 이슈와 PR 대신)

• 상위 수준의 설계 접근 방식(세부 사항은 아래 제안된 설계에 기술)

제안된 설계

설계의 세부 사항(가능하면 구현에는 들어가지 않음).

개요:

• 영향을 받는(변경되는) 서비스/모듈

• 새로 추가되는 서비스/모듈

• 모델 및 DTO에 대한 영향(변경/추가/삭제)

• API에 대한 영향(변경/추가/삭제)

• 일반 설정에 대한 영향(새 섹션 신설, 변경/추가/삭제)

• devops에 대한 영향

고려 사항

ADR 논의에서 제기된 대안, 우려, 부수적이거나 관련된 문제, 질문을 문서화하십시오.

그것들이 해결되거나 완화되었는지, 그리고 어떻게 되었는지 표시하십시오.

결정

합의된 중요한 구현 세부 사항, 주의 사항, 향후 고려 사항, 남아 있거나 연기된 설계 문제를 문서화하십시오.

제안된 설계로 충족되지 않는 요구사항의 부분을 문서화하십시오.

기타 관련 ADR

관련된 ADR을 나열하십시오. 예를 들어 기능의 하위 컴포넌트에 대한 설계 결정, 이 설계의 결과로 폐기된 설계 등..

형식:

• [ADR 제목](URL) - 관련성

참고 자료

추가 참고 자료를 나열하십시오.

형식:

• [제목](URL)