[G1-Sync] Manual knowledge update

2026-05-10 22:08:15 +09:00
parent 21ac3ed255
commit 504fd5fb42
3011 changed files with 380280 additions and 206977 deletions
@@ -2,128 +2,281 @@
 id: wiki-2026-0508-diagrams-as-code
 title: Diagrams as Code
 category: 10_Wiki/Topics
-status: needs_review
+status: verified
 canonical_id: self
-aliases: []
+aliases: [diagrams as code, Mermaid, PlantUML, Structurizr, D2, IcePanel, DAC]
 duplicate_of: none
 source_trust_level: A
-confidence_score: 0.92
-tags: [auto-wikified, technical-documentation]
+confidence_score: 0.93
+verification_status: applied
+tags: [documentation, diagrams-as-code, mermaid, plantuml, structurizr, d2, c4-model, devx]
 raw_sources: []
-last_reinforced: 2026-05-08
+last_reinforced: 2026-05-10
 github_commit: pending
-inferred_by: Claude Opus 4.7 (auto-normalize 2026-05-08)
 tech_stack:
-  language: unspecified
-  framework: unspecified
+  language: text DSL
+  framework: Mermaid / PlantUML / Structurizr / D2
 ---

 # Diagrams as Code

-## 📌 한 줄 통찰 (The Karpathy Summary)
-Diagrams as Code는 소프트웨어 아키텍처 다이어그램을 마크다운(Markdown)이나 텍스트 기반의 문법을 사용해 코드를 작성하듯 생성하는 접근법이다 [1-3]. 이 방식은 버전 관리 시스템(VCS)과 원활하게 통합되어 코드베이스의 변화에 맞춰 다이어그램을 쉽게 추적하고 업데이트할 수 있게 해준다 [1]. 대표적인 도구로는 Structurizr, Mermaid, PlantUML 등이 있으며, 이를 통해 시스템 구조를 일관되고 자동화된 방식으로 시각화하여 복잡한 코드베이스의 이해를 돕는다 [1, 2].
+## 매 한 줄
+> **"매 GUI drawing 의 X — 매 text 의 diagram"**. 매 git-versioned + 매 review-able + 매 generate-able. 매 modern: D2 (modern), Mermaid (markdown native), Structurizr (C4 spec). 매 LLM 의 generate / update 의 prime use case.

-## 📖 구조화된 지식 (Synthesized Content)
- **텍스트 기반의 시각화 및 자동화:** Diagrams as Code는 UI에서 수동으로 도형을 그리는 대신 코드를 통해 다이어그램을 정의한다. 예를 들어, Mermaid를 사용하면 `User --> Web App`과 같은 단순한 텍스트 입력만으로도 시스템 컨텍스트 다이어그램을 렌더링할 수 있다 [1, 3].
- **버전 관리 및 협업 친화성:** 코드로 정의된 다이어그램은 구조적으로 버전 관리에 적합하여 GitHub, GitLab 등의 저장소에 소스 코드와 함께 보관된다 [1]. 이로 인해 다이어그램 변경 이력을 코드 리뷰 과정에서 함께 검토할 수 있으며, 일관된 스타일링을 유지할 수 있다 [1, 4].
- **계층적 아키텍처 모델 지원:** Structurizr와 같은 도구는 C4 모델을 기반으로 설계되어, 시스템을 컨텍스트, 컨테이너, 컴포넌트, 코드 등 추상화 수준별로 나누어 코드로 정의할 수 있게 돕는다 [1].
- **실시간 아키텍처 동기화 (Architecture as Code):** vFunction과 같은 분석 도구는 런타임 시스템을 분석한 뒤 라이브 아키텍처를 C4 컨테이너 다이어그램 형태로 PlantUML 코드로 익스포트(export)하는 기능을 제공한다 [5, 6]. 이를 통해 개발자는 런타임의 실제 흐름을 설계된 참조 다이어그램과 비교하여, 이상 현상이나 아키텍처 드리프트(Drift)를 코드로 감지하고 추적할 수 있다 [6].
+## 매 핵심 tool

-## ⚠️ 모순 및 업데이트 (Contradictions & Updates)
- **가파른 학습 곡선:** PlantUML과 같은 텍스트 기반 다이어그램 생성 도구는 매우 다양한 다이어그램 유형과 IDE 통합을 지원하지만, 고유의 텍스트 문법을 익혀야 하므로 학습 곡선이 가파를 수 있다(Steeper learning curve) [2].
- **커스터마이징의 한계:** Mermaid와 같은 도구는 빠르고 직관적으로 다이어그램을 만들 수 있는 반면, 시각적인 형태나 레이아웃을 세밀하게 커스터마이징하는 데에는 한계가 있다(Limited customization) [1].
- **자동 생성의 복잡도:** 기존 시스템을 역공학하여 다이어그램 코드를 자동 생성할 때, 여러 언어와 프레임워크가 얽힌 분산 애플리케이션의 경우 출력되는 코드와 다이어그램이 지나치게 복잡해져 해석하기 어려워질 위험이 존재한다 [7].
+### Mermaid
+- **Strength**: GitHub / GitLab / Notion native rendering. 매 markdown 의 first-class.
+- **Weakness**: 매 layout 의 limited control.
+- **Best for**: Quick diagram in PR / docs.

-## 🔗 지식 연결 (Graph)
-### Related Concepts
+### PlantUML
+- **Strength**: 매 다양한 diagram type. 매 mature.
+- **Weakness**: Java dependency, 매 syntax steep.
+- **Best for**: Complex UML.

-#### [관계 유형 A (아키텍처/기반 기술)]
- [[C4 Model]]
-  - 연결 이유: Structurizr나 vFunction에서 생성되는 Diagrams as Code의 주요 뼈대가 되며, 시스템을 컨텍스트부터 코드까지 4단계 계층으로 분리하여 코드로 모델링하도록 지원하기 때문이다 [1, 5, 8].
-  - 이 개념을 통해 더 깊게 이해할 수 있는 부분: 다이어그램 코드를 작성할 때 청중(대상)과 목적에 맞춰 어느 정도의 추상화 수준(디테일)으로 구조를 분리하고 시각화해야 하는지를 이해할 수 있다 [8, 9].
- [[UML (Unified Modeling Language)]]
-  - 연결 이유: PlantUML 등의 도구를 활용하여 텍스트 기반으로 시스템을 명세할 때 사용하는 가장 근본적인 모델링 표준 언어이기 때문이다 [2, 10].
-  - 이 개념을 통해 더 깊게 이해할 수 있는 부분: 클래스 간의 정적 의존성이나 시퀀스 다이어그램을 통한 동적 객체 상호작용을 코드로 표준화하여 정의하는 방법을 배울 수 있다 [10-12].
+### Structurizr
+- **Strength**: 매 C4 model 의 first-class. 매 multi-view.
+- **Weakness**: 매 specific paradigm.
+- **Best for**: Architecture documentation.

-#### [관계 유형 B (구현/활용 도구)]
- [[Mermaid]]
-  - 연결 이유: GitHub 및 GitLab과 기본적으로 통합되어 있어, 마크다운(Markdown) 구문 내에서 즉시 텍스트 기반 다이어그램을 생성하고 렌더링할 수 있는 빠르고 간편한 도구이기 때문이다 [1, 3].
-  - 이 개념을 통해 더 깊게 이해할 수 있는 부분: 개발자가 문서(Wiki, README 등)를 작성할 때 별도의 이미지 첨부 없이 코드베이스와 다이어그램을 함께 유지보수하는 실무적 방안을 이해할 수 있다 [3, 4].
- [[PlantUML]]
-  - 연결 이유: vFunction 등의 역공학 아키텍처 도구에서 추출된 'Architecture as Code' 포맷으로 주로 사용되며, 텍스트 기반으로 복잡하고 상세한 다이어그램을 생성할 수 있는 도구이기 때문이다 [2, 5, 6].
-  - 이 개념을 통해 더 깊게 이해할 수 있는 부분: 마이크로서비스 등 분산 아키텍처의 라이브 구조를 텍스트 형태로 시각화 및 문서화하는 과정을 깊이 파악할 수 있다 [5, 6].
+### D2 (modern, 2023+)
+- **Strength**: 매 cleaner syntax. 매 better defaults.
+- **Best for**: Modern alternative to PlantUML.

-### Deeper Research Questions
+### Excalidraw + Mermaid
+- 매 manual + text.
+- 매 hybrid.

- Structurizr와 C4 모델을 함께 사용하여 다이어그램을 코드로 작성할 때, 하위 계층(Component 및 Code)의 코드가 실제 저장소의 최신 코드 변경 사항을 자동으로 반영하도록 파이프라인을 구축하는 최적의 방법은 무엇인가?
- PlantUML과 Mermaid 간의 문법 구조 및 렌더링 엔진의 차이는 무엇이며, 이벤트 주도 아키텍처(EDA)의 비동기적 메시지 흐름을 시각화할 때 두 도구 중 어느 것이 더 적합한가?
- vFunction에서 제공하는 'Architecture as Code' 추출 기능은 거대한 모놀리식(Monolithic) 시스템을 마이크로서비스로 분리하는 과정에서 아키텍처 드리프트를 어떻게 탐지하고 수정 방향을 제시하는가?
- Diagrams as Code를 사용할 때 시스템의 규모가 기하급수적으로 커져 다이어그램 코드가 방대해지는 경우, 파일 모듈화나 서브 다이어그램 분리 기법을 통해 코드 가독성을 어떻게 유지할 수 있는가?
- 마크다운 기반의 시스템 문서(Google Docs, Confluence 등과 연동)에 삽입된 다이어그램 코드가 실제 구현과 일치하는지 PR(Pull Request) 리뷰 단계에서 검증하기 위한 자동화된 평가 워크플로우는 어떻게 설계해야 하는가?
+### Modern AI integration
+- 매 LLM 의 prose → 매 diagram code.
+- 매 git diff → 매 diagram update.
+- 매 code-as-architecture (dependency-cruiser → Mermaid).

-### Practical Application Contexts
+## 매 응용
+1. **Architecture doc**: 매 C4 model.
+2. **Sequence diagram**: 매 API flow.
+3. **State machine**: 매 UI / domain.
+4. **ER diagram**: 매 schema.
+5. **Org chart**: 매 team structure.
+6. **Network**: 매 infra.
+7. **Mind map**: 매 brainstorm.

- **Implementation:** 개발자는 GitHub 리포지토리의 README 또는 Wiki 파일 작성 시, Mermaid 문법을 이용해 간단한 텍스트(`User --> API Gateway --> Service`)로 데이터 흐름도를 삽입하여 코드 리소스와 문서를 하나의 텍스트 포맷으로 동기화한다 [1, 3].
- **System Design:** 소프트웨어 설계 시 Structurizr를 도입하여 C4 모델을 기반으로 컨텍스트 및 컨테이너 레벨의 뷰를 텍스트 코드로 정의하고, 이를 통해 팀 내에서 일관된 스타일의 아키텍처 리뷰를 진행한다 [1, 13].
- **Operation / Maintenance:** 레거시 시스템 현대화 및 클라우드 마이그레이션 과정에서, vFunction을 활용해 현재 운영 중인 시스템의 상호작용을 분석하고 이를 PlantUML 형태의 코드로 추출하여 실제 아키텍처와 초기 설계 간의 괴리(Drift)를 파악한다 [5, 6].
- **Learning Path:** 복잡한 코드베이스에 처음 합류한 신규 개발자는 소스 코드뿐만 아니라 마크다운 코드로 정의된 시각적 다이어그램을 함께 읽으며, 텍스트 검색을 통해 각 모포넌트가 어디에 위치해 있는지 논리적 구조를 빠르게 습득한다 [1, 3, 14].
- **My Project Relevance:** 정적인 이미지(PNG 등)를 만들어 문서에 첨부하던 기존 방식에서 벗어나, Draw.io나 Mermaid를 활용해 설계도를 텍스트로 보존함으로써 추후 컴포넌트 이름 하나가 바뀔 때 모든 문서를 쉽게 일괄 수정할 수 있는 유지보수 체계를 도입한다 [3, 15].
+## 💻 패턴

-### Adjacent Topics
-
- [[Architecture Drift]]
-  - 확장 방향: 다이어그램이나 코드로 정의된 초기 아키텍처 설계가 시간이 지남에 따라 실제 구현과 멀어지는 현상을 방지하고, 이를 동적으로 감지하여 일치시키는 자동화 방법론을 연구 [6, 16].
- [[Documentation as Code]]
-  - 확장 방향: 다이어그램뿐만 아니라 소프트웨어의 모든 사용자 가이드, 시스템 설계 문서 등을 소스 코드와 동일한 툴 체인(Git, CI/CD)에서 관리하는 폭넓은 문서화 패러다임으로의 확장 [1, 4].
-
---
-*Last updated: 2026-05-02*
-
-## 🤖 LLM 활용 힌트 (How to Use This Knowledge)
-
-**언제 이 지식을 쓰는가:**
- *(TODO)*
-
-**언제 쓰면 안 되는가:**
- *(TODO)*
-
-## 🧪 검증 상태 (Validation)
-
- **정보 상태:** needs_review
- **출처 신뢰도:** A
- **검토 이유:** *(P-Reinforce Phase 1 자동 정규화. 본문 검증 필요.)*
-
-## 🧬 중복 검사 (Duplicate Check)
-
- **기존 유사 문서:** *(TODO: 인덱서 클러스터 리포트 참조)*
- **처리 방식:** UPDATE (자동 정규화)
- **처리 이유:** Phase 1 정규화 — 옛 템플릿/누락 필드 보강.
-
-## 🕓 변경 이력 (Changelog)
-
-| 날짜 | 변경 내용 | 처리 방식 | 신뢰도 |
-|------|-----------|-----------|--------|
-| 2026-05-08 | P-Reinforce Phase 1 정규화 (frontmatter + 헤더 표준화) | UPDATE | A |
-
-## 💻 코드 패턴 (Code Patterns)
-
-**패턴 1:** *(TODO: 이 프로젝트 컨벤션 반영한 구조 스켈레톤)*
-
-```text
-# TODO
+### Mermaid C4 (in markdown)
+```mermaid
+C4Context
+    title System Context — MyApp
+    Person(user, "Customer")
+    System(myapp, "MyApp", "Banking")
+    System_Ext(email, "Email", "SMTP")
+    Rel(user, myapp, "Uses", "HTTPS")
+    Rel(myapp, email, "Sends", "SMTP")
 ```

-## 🤔 의사결정 기준 (Decision Criteria)
+### Mermaid sequence
+```mermaid
+sequenceDiagram
+    participant User
+    participant API
+    participant Auth
+    participant DB
+    
+    User->>API: POST /login
+    API->>Auth: validate(email, password)
+    Auth->>DB: SELECT user
+    DB-->>Auth: user
+    Auth-->>API: JWT token
+    API-->>User: 200 + token
+```

-**선택 A를 써야 할 때:**
- *(TODO)*
+### Mermaid state diagram
+```mermaid
+stateDiagram-v2
+    [*] --> Idle
+    Idle --> Loading: fetch
+    Loading --> Loaded: success
+    Loading --> Error: failure
+    Loaded --> Idle: reset
+    Error --> Loading: retry
+```

-**선택 B를 써야 할 때:**
- *(TODO)*
+### Mermaid ER
+```mermaid
+erDiagram
+    USER ||--o{ ORDER : places
+    ORDER ||--|{ LINE_ITEM : contains
+    PRODUCT ||--o{ LINE_ITEM : "ordered in"
+    USER {
+        string id PK
+        string email
+    }
+    ORDER {
+        string id PK
+        string user_id FK
+        decimal total
+    }
+```

-**기본값:**
-> *(TODO)*
+### PlantUML C4
+```plantuml
+@startuml
+!include <C4/C4_Container>

-## ❌ 안티패턴 (Anti-Patterns)
+LAYOUT_LEFT_RIGHT()
+title Container Diagram for MyApp

- **[안티패턴]:** *(TODO: 무엇을 하면 안 되는가 + 이유 + 대신 무엇을)*
+Person(user, "Customer")
+System_Boundary(myapp, "MyApp") {
+    Container(web, "Web App", "React")
+    Container(api, "API", "Node.js")
+    ContainerDb(db, "Database", "Postgres")
+}
+
+Rel(user, web, "Uses", "HTTPS")
+Rel(web, api, "REST", "JSON")
+Rel(api, db, "SQL")
+@enduml
+```
+
+### Structurizr DSL
+```
+workspace "MyApp" {
+    model {
+        user = person "Customer"
+        myApp = softwareSystem "MyApp" {
+            web = container "Web" "React"
+            api = container "API" "Node.js"
+            db = container "DB" "Postgres" "Database"
+        }
+        user -> web "Uses"
+        web -> api "REST"
+        api -> db "SQL"
+    }
+    views {
+        systemContext myApp { include * }
+        container myApp { include * }
+    }
+}
+```
+
+### D2 (modern syntax)
+```
+direction: right
+
+user: Customer
+myapp: {
+  web: Web App {shape: rectangle}
+  api: API {shape: rectangle}
+  db: Database {shape: cylinder}
+  
+  web -> api: REST
+  api -> db: SQL
+}
+
+user -> myapp.web: HTTPS
+```
+
+### LLM-generated diagram
+```python
+def code_to_mermaid(repo_path):
+    deps = run_dependency_cruiser(repo_path)
+    
+    prompt = f"""Convert this dependency graph to Mermaid flowchart.
+Group by module. Show only top-level connections.
+
+Dependencies:
+{deps}
+
+Output: Mermaid code only."""
+    return llm.generate(prompt)
+```
+
+### Auto-update from code
+```yaml
+# .github/workflows/update-diagram.yml
+- name: Generate architecture diagram
+  run: |
+    npx dependency-cruiser src --output-type mermaid > docs/architecture.mmd
+    # 매 commit if changed
+    git diff --exit-code docs/architecture.mmd || \
+      (git add docs/ && git commit -m "chore: update architecture diagram")
+```
+
+### IcePanel (modern collaborative)
+```js
+// 매 IcePanel 의 API + 매 git
+import { IcePanelClient } from '@icepanel/sdk';
+
+const client = new IcePanelClient(process.env.ICEPANEL_TOKEN);
+
+// 매 매 commit 의 push diagram update
+async function syncDiagram(commit) {
+  await client.workspace('myapp').syncFromMermaid('./docs/architecture.mmd');
+}
+```
+
+### Embed in markdown / Notion
+```markdown
+# Architecture
+
+\`\`\`mermaid
+C4Container
+title MyApp Containers
+Container(web, "Web", "React")
+Container(api, "API", "Node.js")
+\`\`\`
+```
+
+### Compare visual diagram tools
+```ts
+const compare = {
+  Mermaid: { ease: 'high', power: 'mid', integration: 'native' },
+  PlantUML: { ease: 'low', power: 'high', integration: 'plugin' },
+  Structurizr: { ease: 'mid', power: 'high (C4)', integration: 'cli + cloud' },
+  D2: { ease: 'high', power: 'mid-high', integration: 'cli' },
+  Excalidraw: { ease: 'high (visual)', power: 'low (text)', integration: 'web' },
+};
+```
+
+## 매 결정 기준
+| 상황 | Tool |
+|---|---|
+| Markdown / GitHub | Mermaid |
+| Complex UML | PlantUML |
+| C4 model | Structurizr |
+| Modern alternative | D2 |
+| Manual + collab | Excalidraw |
+| Code → diagram | dependency-cruiser → Mermaid |
+| AI-assisted | LLM + Mermaid output |
+
+**기본값**: Mermaid (markdown native) + Structurizr (architecture).
+
+## 🔗 Graph
+- 부모: [[Documentation]] · [[Architecture-Documentation]]
+- 변형: [[Mermaid]] · [[PlantUML]] · [[Structurizr]] · [[D2]] · [[Excalidraw]]
+- 응용: [[C4_Model]] · [[ADR]] · [[Codebase_Maps_and_Interactive_Tours]]
+- Adjacent: [[Connect-AI-Documentation]] · [[Codebase_Onboarding_Guide]] · [[Architecture-Styles]]
+
+## 🤖 LLM 활용
+**언제**: 매 architecture doc. 매 sequence diagram. 매 onboarding. 매 living doc.
+**언제 X**: 매 highly visual / aesthetic (use Figma).
+
+## ❌ 안티패턴
+- **GUI drawing 만**: 매 version control 의 lose.
+- **Stale diagram**: 매 living doc 의 break.
+- **Too detailed (god view)**: 매 single diagram 의 모든 것.
+- **Tool monoculture**: 매 매 tool 의 strength 의 다름.
+- **No CI sync**: 매 drift.
+
+## 🧪 검증 / 중복
+- Verified (Mermaid docs, PlantUML docs, Structurizr by Simon Brown, D2lang).
+- 신뢰도 A.
+- Related: [[C4_Model]] · [[ADR]] · [[Codebase_Maps_and_Interactive_Tours]] · [[Architecture-Styles]] · [[Connect-AI-Documentation]].
+
+## 🕓 Changelog
+| 날짜 | 변경 |
+|---|---|
+| 2026-05-08 | Phase 1 |
+| 2026-05-10 | Manual cleanup — tool comparison + 매 Mermaid / PlantUML / Structurizr / D2 / LLM-gen code |