118 lines
5.1 KiB
Markdown
118 lines
5.1 KiB
Markdown
---
|
|
id: wiki-2026-0508-mermaid-diagrams
|
|
title: Mermaid Diagrams
|
|
category: 10_Wiki/Topics
|
|
status: verified
|
|
canonical_id: self
|
|
aliases: [P-REINFORCE-WIKI-DEV-MERMAID-DIAGRAMS, Mermaid, Diagrams as Code, 머메이드, 텍스트 다이어그램]
|
|
duplicate_of: none
|
|
source_trust_level: A
|
|
confidence_score: 1.0
|
|
tags: [Visualization, Documentation, Git, Markdown, Architecture]
|
|
raw_sources: [Datacollector_Export_2026-05-02]
|
|
last_reinforced: 2026-05-02
|
|
github_commit: pending
|
|
tech_stack:
|
|
language: unspecified
|
|
framework: unspecified
|
|
---
|
|
|
|
# [[Mermaid를 활용한 코드 기반 다이어그램 작성 (Mermaid Diagrams)]]
|
|
|
|
## 1. 개요
|
|
Mermaid는 마크다운(Markdown) 기반의 단순한 텍스트 문법을 사용하여 순서도, 시퀀스 다이어그램, 간트 차트 등 다양한 시각적 도표를 생성하는 'Diagrams as Code(코드로서의 다이어그램)' 도구다. 별도의 이미지 편집기 없이 텍스트만으로 복잡한 아키텍처와 로직 흐름을 정의할 수 있어, 개발자 친화적인 문서화 환경을 제공한다.
|
|
|
|
## 2. 주요 특징 및 이점
|
|
- **VCS 친화성**: 다이어그램이 텍스트(코드)로 관리되므로 Git과 같은 버전 관리 시스템을 통해 변경 이력을 추적하고 PR(Pull Request)에서 리뷰가 가능하다.
|
|
- **플랫폼 통합성**: GitHub, GitLab, Notion, Obsidian 등 주요 협업 및 문서화 도구에서 기본적으로 지원되어 별도 플러그인 없이 다이어그램 렌더링 가능.
|
|
- **유지보수 용이성**: 이미지 파일을 매번 수정하고 다시 업로드하는 번거로움 없이, 텍스트 한 줄만 수정하면 다이어그램이 즉시 업데이트됨.
|
|
- **신속한 작성**: GUI 도구에서 마우스로 상자를 그리고 선을 연결하는 대신, 관계를 텍스트(`A --> B`)로 명시하여 매우 빠르게 구조화 가능.
|
|
|
|
## 3. 주요 다이어그램 유형
|
|
- **Flowchart (순서도)**: 비즈니스 로직의 분기 및 처리 흐름 시각화.
|
|
- **Sequence Diagram (시퀀스 다이어그램)**: 객체 간, 혹은 서비스 간의 시간 순서에 따른 메시지 교환 파악.
|
|
- **Class Diagram (클래스 다이어그램)**: 객체 지향 설계의 클래스 구조와 관계 명시.
|
|
- **State Diagram (상태 다이어그램)**: 엔티티의 상태 전이 로직 정의.
|
|
- **Entity Relationship Diagram (ERD)**: 데이터베이스 스키마 및 테이블 간 관계 시각화.
|
|
|
|
## 4. 트레이드오프 및 주의사항
|
|
- **디자인의 제약**: 레이아웃이 자동으로 배치되므로, 상자의 위치나 선의 곡률 등을 세밀하게 조정(Fine-grained customization)하는 데 한계가 있음.
|
|
- **복잡도 임계치**: 다이어그램이 너무 거대해지면 텍스트 코드가 난해해지고 가독성이 떨어질 수 있다. 이 경우 하위 다이어그램으로 분할 권장.
|
|
- **렌더링 의존성**: Mermaid 엔진 버전에 따라 렌더링 결과가 미세하게 다를 수 있으므로, 팀 내 표준 뷰어 설정 필요.
|
|
|
|
## 5. 지식 연결 (Related)
|
|
- [[Documentation_Strategy]]: 시스템 전체의 문서화 체계 내에서 Mermaid의 역할.
|
|
- [[Executable_Documentation]]: 코드로 실행 및 검증되는 문서의 일환으로서의 다이어그램.
|
|
- [[C4_Model]]: Mermaid를 사용하여 표현할 수 있는 아키텍처 추상화 모델.
|
|
|
|
## 🧪 검증 상태 (Validation)
|
|
- **정보 상태**: 검증 완료 (Verified)
|
|
- **출처 신뢰도**: A
|
|
- **검토 이유**: 코드와 지식의 동기화를 유지하며 아키텍처를 시각화하는 핵심 도구 활용 표준 정립.
|
|
|
|
## 📌 한 줄 통찰 (The Karpathy Summary)
|
|
|
|
> *(TODO: 한 문장으로 핵심 통찰을 작성. "X는 Y 조건에서 Z 효과를 낸다" 구조 권장.)*
|
|
|
|
## 📖 구조화된 지식 (Synthesized Content)
|
|
|
|
**추출된 패턴:**
|
|
> *(TODO)*
|
|
|
|
**세부 내용:**
|
|
- *(TODO)*
|
|
|
|
## 🤖 LLM 활용 힌트 (How to Use This Knowledge)
|
|
|
|
**언제 이 지식을 쓰는가:**
|
|
- *(TODO)*
|
|
|
|
**언제 쓰면 안 되는가:**
|
|
- *(TODO)*
|
|
|
|
## 🧬 중복 검사 (Duplicate Check)
|
|
|
|
- **기존 유사 문서:** *(TODO: 인덱서 클러스터 리포트 참조)*
|
|
- **처리 방식:** UPDATE (자동 정규화)
|
|
- **처리 이유:** Phase 1 정규화 — 옛 템플릿/누락 필드 보강.
|
|
|
|
## ⚠️ 모순 및 업데이트 (Contradictions & Updates)
|
|
|
|
- **과거 데이터와의 충돌:** 없음
|
|
- **정책 변화:** 없음
|
|
|
|
## 🔗 지식 연결 (Graph)
|
|
|
|
- **Parent:** [[10_Wiki/Topics]]
|
|
- **Related:** *(TODO: 최소 2개)*
|
|
- **Opposite / Trade-off:** *(TODO)*
|
|
- **Raw Source:** 직접 입력
|
|
|
|
## 🕓 변경 이력 (Changelog)
|
|
|
|
| 날짜 | 변경 내용 | 처리 방식 | 신뢰도 |
|
|
|------|-----------|-----------|--------|
|
|
| 2026-05-08 | P-Reinforce Phase 1 정규화 (frontmatter + 헤더 표준화) | UPDATE | A |
|
|
|
|
## 💻 코드 패턴 (Code Patterns)
|
|
|
|
**패턴 1:** *(TODO: 이 프로젝트 컨벤션 반영한 구조 스켈레톤)*
|
|
|
|
```text
|
|
# TODO
|
|
```
|
|
|
|
## 🤔 의사결정 기준 (Decision Criteria)
|
|
|
|
**선택 A를 써야 할 때:**
|
|
- *(TODO)*
|
|
|
|
**선택 B를 써야 할 때:**
|
|
- *(TODO)*
|
|
|
|
**기본값:**
|
|
> *(TODO)*
|
|
|
|
## ❌ 안티패턴 (Anti-Patterns)
|
|
|
|
- **[안티패턴]:** *(TODO: 무엇을 하면 안 되는가 + 이유 + 대신 무엇을)* |