2025-02-14 · 한도윤
다이어그램 주석을 팀 규약으로 고정하는 법
우리는 클라우드 아키텍처 문서를 만들 때 종류가 다른 다이어그램이 한 페이지에 섞이곤 합니다. 첫째 단락에서는 레이어 이름을 인프라, 애플리케이션, 관측으로 제한하고, 경계선 색은 의미가 아닌 소유 팀을 나타내도록 했습니다. 이렇게 하면 신규 입사자도 범례 없이 흐름을 따라갈 수 있습니다.
둘째 단락에서는 상태 표기를 점선과 실선으로 구분했습니다. 점선은 계획 중인 연결, 실선은 운영 중인 연결입니다. 이 규약은 코드 리뷰가 아니라 설계 리뷰에서 먼저 합의되었고, 위키 템플릿에 기본 레이어로 박혀 있습니다.
셋째 단락에서는 변경 이력을 다이어그램 우측 하단에 짧은 타임스탬프로 남깁니다. 장문의 변경 로그 대신 누가 언제 핵심 경계를 바꿨는지만 보이게 하여 스크롤 피로를 줄였습니다.
넷째 단락에서는 외부 파트너와 공유할 때 민감한 이름을 치환하는 표를 함께 첨부합니다. 치환표는 별도 시트로 관리하며, 다이어그램 파일에는 내부 코드명이 노출되지 않습니다.