체크 아웃 서비스의 카나리아 릴리스

1) 왜 트랜잭션 문서가 필요합니까?

• 구두 지식을 반복 가능한 절차로 바꿉니다.
• 책임 경계 및 에스컬레이션 포인트
• 규정 준수 및 안전에 대한 증거의 원천 역할을합니다.
• 온 보딩을 가속화하고 "좁은 목" 의 위험을 줄입니다.

2) 문서 분류 (무엇)

정책: 의도와 프레임 워크 ("무엇과 이유"). 예: 사고 관리 정책.
표준: 필수 최소 요구 사항 ("얼마나"). 예: TLS 인증서 갱신 날짜.
SOP/절차: 순차적 단계 ("as"). 예: 카나리아 롤과 함께 릴리스하십시오.
런북: 일반적인 이벤트에 대한 단계별 지침 (경고/작업). 예: "API 5xx가 증가했습니다-동작 알고리즘".
플레이 북: 옵션과 포크가있는 일련의 시나리오 솔루션. 예: "결제 제공 업체와의 문제".
K (Knowledge Base): 답변, FAQ, 도구 도움말.
점검표-작업 전에 필요한 항목의 짧은 목록.
기록/증거: 완료된 단계 로그, 스크린 샷/로그/서명.

3) 좋은 문서의 원리

단일 진실의 근원 (SSOT). 문서는 복제되지 않습니다. 스프레이는 쓸모 없게되는 것입니다.
코드 문서. Git에 저장하면 패스 코드 검토, 버전 및 확산이 표시됩니다.
실행 가능한 첫 번째. 처음에는 짧은 카드: 언제 시작해야하는지, 누가 소유자인지, 무엇을해야하는지, 기준을 완료합니다.
원자 성 및 주소 지정 가능성. 하나의 문서-하나의 작업/프로세스.
업데이트 가능성. 명확한 소유자 및 SLA 업데이트 (예: 분기 별).
관찰 가능성. 대시 보드/알림/메트릭에 대한 링크가 내장되어 있습니다.
설계 별 보안. 감도 분류, 비밀 마스킹, 액세스 제어.

4) 문서 수명주기 (거버넌스)

1. 시작: 응용 프로그램/티켓 → 문서 유형 → 소유자.
2. 초안: 템플릿, 최소 예, 표준 및 SLO 참조.
3. 검토: 기술 (SRE/플랫폼/안전), 절차 (프로세스 관리자).
4. 출판: 마스터 브랜치에서 버전/날짜를 표시하고 상태를 지정합니다 (활성/실험/더 이상 사용되지 않음).
5. 교육/커뮤니케이션: 변경 사항 발표, 짧은 교육/데모.
6. 회고: 사건/연습 결과를 바탕으로 변경하십시오.
7. 감사 및 보관: 불변의 추적 (누가/언제 변경되었는지), 보관소의 오래된 버전.

5) SOP/런북 구조 (최소)

1. 카드: 이름, ID, 버전/날짜, 소유자, 책임있는 역할, 관련 정책/표준.
2. 신청시기: 시작 조건 (경고/이벤트/작업 창).
3. 준비: 권리/도구/데이터, 위험 평가, 커뮤니케이션.
4. 단계: 명령/스크린 샷/예상 결과와 함께 번호가 매겨집니다.
5. 성공/롤백 기준: 명확한 SLI/SLO 임계 값.
6. 에스컬레이션: 언제, 어떻게 (채널, 전화, 공급자).
7. 보안/규정 준수: 민감한 데이터, 금지, 조치 기록.
8. 행동 후: 티켓 폐쇄, 상태 업데이트, 증거 수집.
9. 변화의 역사 (변경).

6) 스타일과 디자인 규칙

명확하고 짧음: 1 단계-1 동작-1 결과.
명백한: "실행"..., "확인"..., "롤백"....
스크린 샷/명령: 단계 옆에; 명령 - 복사 된 블록; 예상 출력에 주목하십시오.

변동성: 분기 "A → 단계 X, B → 단계 Y 인 경우"

코호트: 관련 경우-지역/공급자/임차인을 지정합니다.
현지화: 주요 문서-최소 2 개 언어; 번역 상태를 지정하십시오.
태그 및 검색: 서비스, 구성 요소, 공급자, 사고 유형, SLO, 버전.

7) 코드 및 도구 문서

스토리지: Git (기본/feat/버그 수정), PR 검토, 필요한 검사.
형식: Markdown/AsciiDoc; PlantUML/Mermaid JSON/YAML 체계의 차트.
출판: 정적 사이트 (Docusaurus/MkDocs) + 검색.
검증: CI-lint, 링크 테스트, 철자, 코드 블록 유효성 검사기.
통합: ChatOps 명령 '/런북 열기 X ', 최신 버전의 알림이 표시됩니다.

링크: CMDB/서비스 카탈로그

8) 액세스 제어 및 분류

차이나: 공개/내부/기밀/제한.
분리: 공개 명령 (일반 상태) vs 개인 (키, 명령, 네트워크 다이어그램).

비밀: 본문에서 금지; 비밀 보관 및 장소 홀더를 사용하십시오

감사-민감한 SOP에 대한 로그 읽기/변경

9) 사건 및 릴리스와의 커뮤니케이션

각 경고에서 관련 런북에 대한 링크.
각 사건에서 사용 된 SOP에 대한 참조 및 마크 확인.
RCA 이후-문서를 CAPA 조치로 업데이트하십시오.
출시 전-체크리스트: 롤백 준비, 열화 플래그, 공급자 연락처.

10) 최소 필요 세트 (MVP Dock Pack)

사건 관리 및 확대 정책 (SEV/P 수준, 타이밍).
표준 및 경보 정책 모니터링 (연소율, 쿼럼).
SOP: 릴리스/롤백 (카나리아/청록색), 데이터베이스 마이그레이션 (확장/계약).
런북: "높은 오류율", "p99 성장", "지불 성공률 감소", "TLS/DNA 문제".
외부 제공 업체의 플레이 북 (결제/KYC/CNC): 연락처, 한계, 폴백.
비밀 및 액세스 관리 정책.
RCA 및 사후 템플릿.
RACI (Service Ownership Table) 및 대시 보드 맵.

11) 문서 품질 지표 (문서 SLO)

적용 범위: SOP/Runbook을 사용한 중요한 경로의%.
신선도: 문서의 비율은 N 일보다 최근입니다 (예: 90).
사용성: 에스컬레이션없이 런북에 따라 사고의% 가 종료되었습니다.
확인 성: 원하는 문서의 중간 검색 시간 (폴링/로그 별).
결함률: 검토 당 댓글 수/100 문서.
채택: 런북 참조가 올바른 경고 비율.
준수 증거율: 증거가 첨부 된 작업의%.

12) 점검표

SOP 생성 점검표

• 소유자 및 대상 잠재 고객이 정의되었습
• 시작 조건과 정지 기준이 있습니다.
• 단계는 다른 엔지니어가 확인하여 재현 가능합니다.
• 대시 보드/알림/도구에 대한 내장 링크.
• 비밀이 없습니다. 장소 홀더와 볼트 링크가 있습니다.
• 롤백 및 에스컬레이션을 설명합니다.
• "행동 후" 체크리스트가 추가되었습니다.
• 버전, 날짜, 변경 로그.

검토 체크리스트

• 문서는 분류 체계에 해당합니다 (정책과 단계를 혼합하지 않음).
• 언어는 모호하지 않고 단순하고 명령적입니다.
• 팀은 "드라이 런 "/스테이지에서 테스트했습니다.
• 위험 및 제어 지점이 표시됩니다.
• 내부/제한이 정확합니다.
• Linters/validators는 CI를 통과했습니다.

13) 현지화, 버전 및 가용성

버전: 'MAJOR. 미노르. MAJOR가 프로세스 호환성을 차단하는 PATCH '.
언어: "소스" 언어 및 번역 상태를 표시하십시오 (최신/필요 검토).
폼 팩터: 통화 중, 인쇄 된 IC 카드를위한 모바일/야간 디스플레이.

14) 도크 자동화 (실제로부터)

CLI 템플릿에서 SOP 프레임 워크 생성 ('doc New sop-service = payment').
서비스 태그별로 최신 대시 보드에 대한 자동 삽입 링크.
연장 된 문서는 봇 (신선도 SLA) 을 상기시킵니다.
감사를 위해 해당 기간 (CP/ZIP) 동안 증거 패키지를 내보냅니다.
솔루션에 사용 된 문서 버전과 사건 티켓을 연결하십시오.

15) 안전 및 준수

필수 섹션 "위험" 및 "제어 조치".
서명/해시가있는 변경되지 않는 아카이브에 증거를 저장합니다.
규정 제한 (예: 알림/보존 기간), 명시 적 준수 소유자.

16) 반 패턴

소유자가없는 "Wiki Maze" 및 업데이트 날짜.

정치인들은 팀과 혼합되어 있습니다. 아무도해야 할 일을 찾지 못할

컨텍스트가없는 문서 (SLO, 대시 보드, 에스컬레이션 없음).

CLI 대안없이 비밀 또는 "여기를 클릭하십시오" 명령어가있는 스크린 샷

"한 전문가는 어떻게 알고 있습니까?" -고정없는 부족 지식.
유일한 버전으로 보관 된 PDF는 편집되지 않고 검색되지 않습니다.

17) 템플릿 (조각)

SOP 캡 (예)

SOP-ID: OPS-REL-001

18) 일상 업무 수행

주간 문서 서클: 1-2 문서 분석, 업데이트, 경험 교환.
게임 일: SOP/런북 리얼리티 체크 시뮬레이션.
온 보딩: 필수 문서 세트 + 짧은 퀴즈를 통한 초보자의 경로.
도크 부채: 우선 순위에 따른 개선 백 로그 (충격 × 노력).

19) 결론

거래 문서는 아카이브가 아니라 작업 도구입니다. 코드로 관리되고 소유자, 신선도 측정 항목이 있으며 사고, 릴리스 및 교육에 포함되면 실수 감소, 빠른 반응, 이해할 수있는 책임 및 감사 준비 상태 등 조직이 예측 가능해집니다. 간단히 작성하고 정기적으로 업데이트하고 루틴을 자동화하면 문서가 시간과 비용을 절약하기 시작합니다.