정책 / 상세목록으로

문서 공개 및 변경 관리 정책

OnCC의 업데이트와 매뉴얼은 데이터베이스가 아닌 Git의 Markdown을 기준 데이터로 사용합니다. 코드와 문서가 같은 검토·배포 이력을 가지도록 하기 위한 정책입니다.

공개 범위

  • Public은 로그인 없이 제공하며 사용자 관점의 기능, 개선, 장애 정정과 사용 절차만 기록합니다.
  • Private 표시는 ADMIN 전용 개발·운영 문서를 의미합니다.
  • 계정, 실제 접속정보와 고객 데이터가 포함된 Git-only 문서는 서비스 화면과 Docker 이미지에 포함하지 않습니다.

검토와 공개

  • 새 문서는 draft로 시작하고 담당자 검토 후 published로 변경합니다.
  • 사용자 영향 코드가 배포될 때 같은 범위에 published 릴리즈 문서가 없으면 배포를 차단합니다.
  • 공개 후 수정은 삭제나 덮어쓰기가 아니라 정정일과 정정 사유를 남깁니다.

책임과 인수인계

  • 릴리즈 문서에는 적용일, 버전, 사용자 조치 여부와 관련 매뉴얼을 명시합니다.
  • 내부 문서의 Git 범위는 실제 커밋 존재와 선후 관계를 자동 검증합니다.
  • 화면에 표시된 내용과 배포 이미지의 Git revision을 함께 운영 근거로 사용합니다.