feat: Wiki 지식 자산 업데이트 - UX Scenarios, Frontend, Game Design, Topics 추가 [2026-05-08]
This commit is contained in:
@@ -1,29 +1,40 @@
|
||||
---
|
||||
category: Unified
|
||||
tags: [auto-wikified, technical-documentation]
|
||||
id: wiki-2026-0508-diagrams-as-code
|
||||
title: Diagrams as Code
|
||||
description: "Diagrams as Code는 소프트웨어 아키텍처 다이어그램을 마크다운(Markdown)이나 텍스트 기반의 문법을 사용해 코드를 작성하듯 생성하는 접근법이다 [1-3]."
|
||||
last_updated: 2026-05-02
|
||||
category: 10_Wiki/Topics
|
||||
status: needs_review
|
||||
canonical_id: self
|
||||
aliases: []
|
||||
duplicate_of: none
|
||||
source_trust_level: A
|
||||
confidence_score: 0.92
|
||||
tags: [auto-wikified, technical-documentation]
|
||||
raw_sources: []
|
||||
last_reinforced: 2026-05-08
|
||||
github_commit: pending
|
||||
inferred_by: Claude Opus 4.7 (auto-normalize 2026-05-08)
|
||||
tech_stack:
|
||||
language: unspecified
|
||||
framework: unspecified
|
||||
---
|
||||
|
||||
# Diagrams as Code
|
||||
|
||||
## 📌 Brief Summary
|
||||
## 📌 한 줄 통찰 (The Karpathy Summary)
|
||||
Diagrams as Code는 소프트웨어 아키텍처 다이어그램을 마크다운(Markdown)이나 텍스트 기반의 문법을 사용해 코드를 작성하듯 생성하는 접근법이다 [1-3]. 이 방식은 버전 관리 시스템(VCS)과 원활하게 통합되어 코드베이스의 변화에 맞춰 다이어그램을 쉽게 추적하고 업데이트할 수 있게 해준다 [1]. 대표적인 도구로는 Structurizr, Mermaid, PlantUML 등이 있으며, 이를 통해 시스템 구조를 일관되고 자동화된 방식으로 시각화하여 복잡한 코드베이스의 이해를 돕는다 [1, 2].
|
||||
|
||||
## 📖 Core Content
|
||||
## 📖 구조화된 지식 (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].
|
||||
|
||||
## ⚖️ Trade-offs & Caveats
|
||||
## ⚠️ 모순 및 업데이트 (Contradictions & Updates)
|
||||
- **가파른 학습 곡선:** PlantUML과 같은 텍스트 기반 다이어그램 생성 도구는 매우 다양한 다이어그램 유형과 IDE 통합을 지원하지만, 고유의 텍스트 문법을 익혀야 하므로 학습 곡선이 가파를 수 있다(Steeper learning curve) [2].
|
||||
- **커스터마이징의 한계:** Mermaid와 같은 도구는 빠르고 직관적으로 다이어그램을 만들 수 있는 반면, 시각적인 형태나 레이아웃을 세밀하게 커스터마이징하는 데에는 한계가 있다(Limited customization) [1].
|
||||
- **자동 생성의 복잡도:** 기존 시스템을 역공학하여 다이어그램 코드를 자동 생성할 때, 여러 언어와 프레임워크가 얽힌 분산 애플리케이션의 경우 출력되는 코드와 다이어그램이 지나치게 복잡해져 해석하기 어려워질 위험이 존재한다 [7].
|
||||
|
||||
## 🔗 Knowledge Connections
|
||||
|
||||
## 🔗 지식 연결 (Graph)
|
||||
### Related Concepts
|
||||
|
||||
#### [관계 유형 A (아키텍처/기반 기술)]
|
||||
@@ -66,4 +77,53 @@ Diagrams as Code는 소프트웨어 아키텍처 다이어그램을 마크다운
|
||||
- 확장 방향: 다이어그램뿐만 아니라 소프트웨어의 모든 사용자 가이드, 시스템 설계 문서 등을 소스 코드와 동일한 툴 체인(Git, CI/CD)에서 관리하는 폭넓은 문서화 패러다임으로의 확장 [1, 4].
|
||||
|
||||
---
|
||||
*Last updated: 2026-05-02*
|
||||
*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
|
||||
```
|
||||
|
||||
## 🤔 의사결정 기준 (Decision Criteria)
|
||||
|
||||
**선택 A를 써야 할 때:**
|
||||
- *(TODO)*
|
||||
|
||||
**선택 B를 써야 할 때:**
|
||||
- *(TODO)*
|
||||
|
||||
**기본값:**
|
||||
> *(TODO)*
|
||||
|
||||
## ❌ 안티패턴 (Anti-Patterns)
|
||||
|
||||
- **[안티패턴]:** *(TODO: 무엇을 하면 안 되는가 + 이유 + 대신 무엇을)*
|
||||
Reference in New Issue
Block a user