훨씬 더 유용한 주석이 되었습니다. 사용 사례(use case)와 우려사항, 해법, 그리고 지불해야 할 트레이드 오프나 비용까지 명시합니다.
유용해졌을 뿐만 아니라 작성하기도 쉽습니다. 템플릿을 사용해 필요한 부분만 간단히 채웠습니다. 아래를 보세요.
In the context of [USE CASE], [사용 사례]의 맥락에서
facing [CONCERN] 직면하는 [우려사항]과
we decided for [OPTION] 우리가 선택한 [해법]으로
to achieve [QUALITY], 얻게 되는 [품질]과
accepting [DOWNSIDE]. 받아들여야 하는 [단점]
코드를 보면 이러한 구조를 쉽게 알아채고 찾을 수 있습니다. 이러한 템플릿을 사용하면 주요 측면을 빠뜨리는 경우가 거의 없습니다. 이해하기 쉽고 미리 정의된 구조를 따르므로 동료 개발자가 주석을 이해하기도 더 쉽고요. 드디어 팀 규칙이 제 역할을 하는 순간입니다.
중요한 결정이나 코드에서 까다로운 부분을 설명할 때는 꼭 위 템플릿을 사용하세요. 똑같지 않아도 되지만 규칙은 도움이 됩니다. 그러니 프로젝트에서 이러한 상황을 처음 만나면 팀 회의를 열고 프로젝트 템플릿을 결정하세요!* 그리고 list 필드를 설명한 주석에서처럼 코드에서 영향을 받는 부분도 반드시 함께 표시하세요.
* 위 템플릿은 지속 가능한 구조적 디자인 결정에서 발췌한 실제 과학적 추천 사항입니다. adr.github.io에 템플릿이 더 있습니다.
역주 ADR(Architecture Decision Records)은 아키텍처 의사 결정을 뜻합니다. github 페이지에는 각 프로그래밍 언어에서 사용할 수 있는 도구와 템플릿이 제공됩니다.