25분
아키텍처 문서와 운영 매뉴얼 - 시스템의 지도를 그려라
Day 1: 기술 문서화 - 코드를 넘어 이야기를 남겨라
아키텍처 문서와 운영 매뉴얼 - 시스템의 지도를 그려라
발표 & 포트폴리오 > Day 1: 기술 문서화 - 코드를 넘어 이야기를 남겨라
학습 목표
아키텍처 문서의 핵심 구성 요소를 이해한다 운영 매뉴얼에 반드시 포함해야 할 항목을 파악한다 Mermaid 다이어그램 활용법을 익힌다
아키텍처 문서: 왜 필요한가?
README는 "이 프로젝트가 뭔지" 알려준다. 아키텍처 문서는 "이 시스템이 어떻게 돌아가는지" 알려준다.
에디터 로딩 중...
아키텍처 문서 구조 (C4 Model 기반)
| 레벨 | 이름 | 독자 | 내용 |
|---|---|---|---|
| L1 | System Context | 비개발자 | 시스템과 외부 연동 |
| L2 | Container | 아키텍트 | 서비스/DB/큐 구성 |
| L3 | Component | 개발자 | 모듈/클래스 수준 |
| L4 | Code | 유지보수자 | 핵심 클래스 UML |
제조 AI 프로젝트에서는 L2 (Container) + 데이터 흐름도가 핵심
제조 AI 시스템의 데이터 흐름도
에디터 로딩 중...
Mermaid로 다이어그램 그리기
GitHub README에서 바로 렌더링되는 Mermaid:
에디터 로딩 중...
에디터 로딩 중...
장애 대응 런북 (Runbook) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━
증상: Neo4j 연결 실패 원인: 1) Neo4j 컨테이너 다운 2) 메모리 부족 3) 볼륨 마운트 이상
대응:
- docker ps | grep neo4j 로 상태 확인
- docker logs neo4j --tail 50 로 로그 확인
- 컨테이너 재시작: docker-compose restart neo4j
- 메모리 부족 시: NEO4J_HEAP_SIZE 조정 후 재시작
에스컬레이션:
- 30분 내 해결 안 되면 → 인프라팀 연락
에디터 로딩 중...