40분

아키텍처 문서 & 운영 매뉴얼 작성 실습

Day 1: 기술 문서화 - 코드를 넘어 이야기를 남겨라

학습 목표

C4 모델 L2 수준의 아키텍처 문서를 작성한다 데이터 흐름도를 ASCII 또는 Mermaid로 작성한다 장애 대응 런북을 작성한다

미션: "새벽 3시에도 복구할 수 있는" 운영 문서

상황

당신의 제조 AI 시스템이 프로덕션에 배포됐다. 그런데 당신이 휴가 중일 때 장애가 발생하면? 당직자가 이 문서만 보고 복구할 수 있어야 한다.

요구사항

Part 1: 아키텍처 문서 (docs/ARCHITECTURE.md)

시스템 개요 (1문단)
컨테이너 구성도 (ASCII 또는 Mermaid)
데이터 흐름도 (질문 → 응답까지)
컴포넌트 설명 표
기술 선택 이유 (ADR: Architecture Decision Record)

Part 2: 운영 매뉴얼 (docs/OPERATIONS.md)

배포 절차 (step-by-step)
환경변수 목록
모니터링 포인트
장애 대응 런북 3개 이상
백업/복구 절차

에디터 로딩 중...

정답 보기

에디터 로딩 중...