7분
아키텍처 문서 & 운영 매뉴얼 작성 실습
Day 1: 기술 문서화 - 코드를 넘어 이야기를 남겨라
아키텍처 문서 & 운영 매뉴얼 작성 실습
발표 & 포트폴리오 > 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개 이상
- 백업/복구 절차
에디터 로딩 중...
정답 보기
에디터 로딩 중...
AI로 학습하기 — 꿀팁
C4 L2 구성요소 식별 질문AI 학습 팁
AI에게 제조 AI PdM 시스템을 C4 모델 L2로 표현할 때 어떤 컨테이너를 분리해야 하는지 기준을 물어보며 아키텍처 문서를 설계하세요.
제조 AI PdM 시스템을 C4 모델 L2(Container Diagram)로 표현할 때 센서 수집, 전처리, ML 추론, RAG 검색, API Gateway를 각각 별도 컨테이너로 분리해야 하는지, 아니면 합쳐도 되는지 설계 기준을 알려줘. 그리고 Mermaid C4Context 문법으로 이 시스템의 기본 다이어그램 뼈대를 작성해줘.
이 팁이 도움이 됐나요?
실습 — 직접 해보기
Mermaid Studio
아키텍처 그림과 데이터 흐름도를 여기서 그려 SVG·PNG 로 내려받아 문서에 넣으세요. 다이어그램이 코드이므로 문서와 함께 git 으로 관리됩니다. 문법 검사와 렌더까지이고 내용이 맞는지는 판정하지 않습니다.