--- kind: REFERENCE slug: messaging-policy-f07 title: 저장소 밖 문서를 절 번호로 인용하지 않는다 topic: declaration-and-document-drift project: clean-architecture-backend-template status: 게시 전 sourceRevision: 21234e38cdb9a926cbc92bb97a2aee2e4a7d2916 rootTreeNode: reference:messaging-policy-f07 verifiedOn: # 이 기록은 이번 회차에 실행 확인을 하지 않았다 source: - final/document.md#a19-messaging-policy#L835 --- # 저장소 밖 문서를 절 번호로 인용하지 않는다 ## 관계 - **재시도 엔진과 DLQ 조정자가 bean으로 만들어지고 주입되는 곳이 없다** 이 규칙의 근거는 같은 분석 리프의 판정이 소유한다. - **재시도와 DLQ 각각에 두 개의 구현이 있고 정본이 표시되지 않았다** 이 규칙의 근거는 같은 분석 리프의 판정이 소유한다. - **DLQ 메타데이터의 두 시각이 항상 같다** 이 규칙의 근거는 같은 분석 리프의 판정이 소유한다. ## 목적 인용된 내용이 코드와 일치해도, 근거를 확인하려는 사람이 그 문서에 도달할 수 없으면 인용은 검증 불가능한 권위가 된다. ## 규칙 1. javadoc 의 문서 인용이 저장소 안에서 해소되는지 확인한다 InFlightLimiter javadoc 이 "Section 40.3 of the design specifies 'bounded wait, then MessageBackpressureException'" 이라고 적는다. 그 절 번호를 가진 문서를 저장소에서 찾지 못했다. 2. 해소되지 않으면 절 번호를 빼고 인용문만 남긴다 인용문 자체는 코드와 일치하므로 내용 drift 가 아니다. 문제는 좌표다. 3. 실제 문서가 있으면 그 경로로 바꾼다 경로는 검색으로 확인 가능하고 절 번호는 아니다. ## 적용 조건 javadoc·주석·README 가 외부 설계 문서를 좌표로 인용하는 모든 자리. ## 예외 저장소에 함께 커밋된 문서의 절 번호는 이 규칙의 대상이 아니다. 그 좌표는 같은 리비전 안에서 해소된다. ## 예시 InFlightLimiter.java:11-13 의 인용문과, docs/messaging/*.md 10개 및 계획 문서에 절 40.3 이 없다는 것. 확인 방법은 git grep -n '40\.3' -- docs 다.