시스템 기준선
안정 문서
플랫폼 아키텍처, 서비스 경계, 장기적으로 유효한 엔지니어링 결정을 정리합니다.
RGB Docs
RGB 내부 엔지니어링 문서
엔지니어링, 운영, QA, 딜리버리 협업을 위해 RGB 플랫폼 아키텍처, 서비스 경계, 의사결정 기록, 변경 계획, 운영 Runbook을 저장소와 동기화된 공식 내부 참고 자료로 관리합니다.
문서 관리 원칙
- Git의 Markdown을 단일 출처로 유지하며 모든 변경은 저장소에서 검토합니다.
- 아키텍처, 서비스 경계, 운영 절차는 검토 가능하고 추적 가능해야 합니다.
- 깨진 링크와 빌드 오류는 오래된 문서가 배포되기 전에 CI에서 차단됩니다.
- 명세, 계획, Runbook은 변경 생명주기별로 보관되어 의사결정 맥락을 유지합니다.
변경 관리
변경 문서
마이그레이션, 기능 변경, 구현 계획, 운영 절차를 기록합니다.
운영 지원
지원 자료
일상 협업을 위한 참고 자료, 이력 근거, 재사용 가능한 템플릿을 보관합니다.
사용 방식
내부 협업 경로
아키텍처 리뷰, 서비스 변경, 운영 이슈, 릴리스 준비 시 안정 문서에서 맥락을 먼저 확인한 뒤 관련 변경 문서와 Runbook으로 이동합니다.
- 아키텍처: 시스템 토폴로지, 도메인 경계, 핵심 데이터 흐름을 확인합니다.
- 서비스 매뉴얼: 역할, 진입점, 의존성, worker, 운영 방식을 확인합니다.
- ADR: 현재 코드만으로 의도를 추정하지 않고 핵심 설계 선택의 배경을 이해합니다.
- 명세와 계획: 범위, 목표, 승인 기준, 실행 상태를 확인합니다.
- Runbook: 로컬, 스테이징, 운영 작업 전에 절차와 위험을 확인합니다.
- 참고 자료: 이력과 외부 자료는 근거로만 사용하고 현재 설계의 출처로 대체하지 않습니다.