bluemsi/2nd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[G1-Sync] Manual knowledge update

Browse Source
This commit is contained in:
Antigravity Agent
2026-05-10 22:08:15 +09:00
parent 21ac3ed255
commit 504fd5fb42
3011 changed files with 380280 additions and 206977 deletions
Download Patch File Download Diff File Expand all files Collapse all files
10_Wiki/Topics/AI_and_ML/Structurizr.md
+132 -90
View File
@@ -2,117 +2,159 @@
id: wiki-2026-0508-structurizr
title: Structurizr
category: 10_Wiki/Topics
status: needs_review
status: verified
canonical_id: self
aliases: []
aliases: [Structurizr DSL, C4 Tooling]
duplicate_of: none
source_trust_level: A
confidence_score: 0.92
tags: [auto-wikified, technical-documentation]
confidence_score: 0.9
verification_status: applied
tags: [architecture, c4-model, diagrams-as-code, documentation]
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: dsl
framework: structurizr
---
# Structurizr
## 📌 한 줄 통찰 (The Karpathy Summary)
Structurizr는 '다이어그램을 코드로 작성(Diagrams as Code)'하는 방식을 사용하는 소프트웨어 아키텍처 다이어그램 도구이다 [1]. 이 도구는 C4 모델을 기반으로 시스템을 구조화하여 다이어그램을 코드로 정의하도록 지원한다 [1]. 이를 통해 버전 관리 시스템과 쉽게 통합되며 문서의 일관된 스타일링을 제공하는 것이 특징이다 [1].
## 매 한 줄
> **"매 architecture-as-code 의 reference impl"**. Simon Brown 의 C4 model 을 textual DSL 로 표현 → 다양한 view (Context, Container, Component, Code) 의 자동 generation. 2026 의 AI-aided (Claude, Cursor) 의 architectural diagram 생성 의 default tooling 중 하나.
## 📖 구조화된 지식 (Synthesized Content)
* **C4 모델 기반 (Based on C4 model)**: Structurizr는 C4 모델에 기반을 두고 설계되었다 [1]. C4 모델은 시스템의 아키텍처를 Context(컨텍스트), Containers(컨테이너), Components(컴포넌트), Code(코드)의 네 가지 계층적 추상화 수준으로 분리하여, 독자(경영진, 기획자, 개발자 등)에게 필요한 수준의 디테일을 제공하는 아키텍처 문서화 모델이다 [1, 2].
* **코드로서의 다이어그램 (Diagrams as Code)**: 시각적인 드래그 앤 드롭 방식이 아닌, 코드를 통해 다이어그램을 직접 정의할 수 있다 [1]. 이러한 특징 덕분에 소프트웨어 코드와 함께 다이어그램을 형상 관리하고 버전 관리(Version control friendly)하기에 매우 용이하다 [1].
* **일관성 있는 스타일링 (Consistent styling)**: 코드로 다이어그램 요소들을 관리하므로, 팀과 프로젝트 전반에 걸쳐 일관된 시각적 스타일과 규칙을 유지할 수 있다 [1].
## 매 핵심
## ⚠️ 모순 및 업데이트 (Contradictions & Updates)
소스에 관련 정보가 부족합니다. (제공된 소스에는 Structurizr 사용 시 발생할 수 있는 구체적인 부작용, 제약 사항 또는 Trade-off에 대한 내용이 직접적으로 포함되어 있지 않습니다.)
### 매 C4 model recap
- **Level 1 — Context**: System 의 user, external system 과 의 관계.
- **Level 2 — Container**: Application, datastore, microservice 의 deployment unit.
- **Level 3 — Component**: Container 내부 의 logical group.
- **Level 4 — Code**: 매 class diagram (rarely needed).
## 🔗 지식 연결 (Graph)
### Related Concepts
### 매 Structurizr 형태
- **Structurizr DSL**: text-based, 매 single source of truth.
- **Structurizr CLI**: DSL → JSON workspace, export to PlantUML, Mermaid, D2.
- **Structurizr Lite**: 매 self-hosted preview (Docker).
- **Structurizr Cloud**: 매 hosted SaaS.
#### [관계 유형 A (아키텍처/기반 기술)]
- [[C4 Model]]
- 연결 이유: Structurizr가 기본적으로 채택하고 있는 아키텍처 다이어그램의 계층적 추상화 모델이기 때문이다 [1, 2].
- 이 개념을 통해 더 깊게 이해할 수 있는 부분: Structurizr가 왜 시스템을 4단계(Context, Containers, Components, Code)로 나누어 확대/축소(Zooming in/out)하는 방식으로 표현하는지, 그리고 어떤 방식으로 복잡한 코드베이스 구조를 논리적으로 분리하는지 이해할 수 있다 [2].
### 매 응용
1. Onboarding documentation (engineer hire 의 first-day reading).
2. ADR companion (decision record 의 visual context).
3. AI-aided refactoring planning (Claude 가 DSL 생성).
4. Compliance / audit (SOC2, ISO27001 의 system diagram).
#### [관계 유형 B (구현/활용 도구)]
- [[Mermaid]]
- 연결 이유: Structurizr와 동일한 'Diagrams as Code' 범주에 속하는 마크다운(Markdown) 기반 다이어그램 도구이다 [1].
- 이 개념을 통해 더 깊게 이해할 수 있는 부분: 텍스트 기반 다이어그램이 GitHub/GitLab 등의 저장소에 어떻게 통합되어 빠르고 간편하게 코드의 시각적 문서화에 기여하는지 비교해 볼 수 있다 [1].
- [[PlantUML]]
- 연결 이유: 텍스트 기반으로 다양한 다이어그램을 생성하며 IDE 통합을 지원하는 또 다른 대표적인 Diagrams as Code 도구이다 [3].
- 이 개념을 통해 더 깊게 이해할 수 있는 부분: 코드로 다이어그램을 작성할 때 발생할 수 있는 높은 학습 곡선(Steeper learning curve)과 텍스트 문법을 활용한 아키텍처 표현 방식의 다양성을 이해할 수 있다 [3].
## 💻 패턴
### Deeper Research Questions
- Structurizr를 활용하여 C4 모델을 코드로 구현할 때, 실제 소스 코드의 변경 사항과 다이어그램을 어떻게 동기화하여 아키텍처 드리프트(Architectural drift)를 방지할 수 있는가?
- 기존 수동 시각화 도구(예: Lucidchart, Draw.io)에서 'Diagrams as Code'인 Structurizr로 전환할 때 발생하는 팀 내 학습 곡선과 생산성의 변화는 어떠한가?
- 대규모 코드베이스에서 Structurizr 코드가 커지고 복잡해질 때, 다이어그램 코드를 어떻게 모듈화하고 관리해야 하는가?
- Structurizr의 일관된 스타일링(Consistent styling) 기능이 여러 마이크로서비스 팀의 아키텍처 문서 통합에 구체적으로 어떻게 기여하는가?
- Structurizr로 작성된 다이어그램을 리뷰하는 과정은 일반적인 소스 코드 풀 리퀘스트(Pull Request) 리뷰와 어떤 차별점이 있는가?
### Basic workspace (DSL)
```dsl
workspace "PaymentSystem" {
model {
user = person "Customer"
paymentSystem = softwareSystem "Payment System" {
webApp = container "Web App" "Next.js" "TypeScript"
api = container "API" "Hono on Bun" "TypeScript"
db = container "Database" "PostgreSQL" "Database"
}
stripe = softwareSystem "Stripe" "External payment provider" "External"
### Practical Application Contexts
- **Implementation:** 아키텍처 다이어그램을 코드로 작성하여 실제 개발 소스 코드와 동일한 저장소에서 Git과 같은 버전 관리 시스템에 커밋하고 추적하는 데 활용한다 [1].
- **System Design:** C4 모델을 적용하여 시스템이 외부와 어떻게 상호작용하는지(Context), 주요 기술 블록은 무엇인지(Containers)를 명확히 코드로 설계하고 시각화하여 팀 간 이해를 일치시킨다 [1, 2].
- **Operation / Maintenance:** 시스템 구조가 진화함에 따라 오래된 이미지 다이어그램을 방치하는 대신, 다이어그램 코드만 업데이트하여 코드베이스와 항상 최신 상태의 아키텍처 문서를 동기화하여 유지보수성을 높인다 [1, 4].
- **Learning Path:** 복잡한 코드베이스를 처음 접하는 개발자가 C4 모델 다이어그램을 분석함으로써, 최상위 비즈니스 흐름부터 내부 컴포넌트까지 하향식(Top-down)으로 시스템을 이해하는 데 사용된다 [2].
- **My Project Relevance:** 복잡한 모듈로 구성된 프로젝트에서 코드베이스를 효과적으로 해독하고 공유하기 위해, 'Diagrams as Code' 접근법으로 시스템 의존성을 명세하고 리뷰하는 문서화 자동화 파이프라인 구축에 활용된다.
### Adjacent Topics
- [[Architecture Diagrams]]
- 확장 방향: 아키텍처 다이어그램이 왜 필요한지(커뮤니케이션, 문서화, 의사결정), 그리고 목적에 따른 다양한 다이어그램 타입(Context, Container, Sequence 등)의 사용 기준을 학습하여 Structurizr의 활용도를 더욱 높일 수 있다 [5-10].
---
*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
user -> webApp "Uses"
webApp -> api "Calls" "HTTPS/JSON"
api -> db "Reads/Writes" "SQL"
api -> stripe "Charges" "HTTPS"
}
views {
systemContext paymentSystem { include * autolayout lr }
container paymentSystem { include * autolayout lr }
theme default
}
}
```
## 🤔 의사결정 기준 (Decision Criteria)
### Component view (Level 3)
```dsl
component api {
authController = component "AuthController" "JWT validation"
paymentService = component "PaymentService" "Charge orchestration"
stripeClient = component "StripeClient" "Stripe SDK wrapper"
**선택 A를 써야 할 때:**
- *(TODO)*
authController -> paymentService "Delegates"
paymentService -> stripeClient "Uses"
}
```
**선택 B를 써야 할 때:**
- *(TODO)*
### Export to other formats
```bash
docker run --rm -v $PWD:/usr/local/structurizr structurizr/cli \
export -workspace workspace.dsl -format plantuml
docker run --rm -v $PWD:/usr/local/structurizr structurizr/cli \
export -workspace workspace.dsl -format mermaid
```
**기본값:**
> *(TODO)*
### Structurizr Lite (local preview)
```bash
docker run -it --rm -p 8080:8080 \
-v $PWD:/usr/local/structurizr \
structurizr/lite
# open http://localhost:8080
```
## ❌ 안티패턴 (Anti-Patterns)
### AI-aided generation (Claude prompt)
```
Given this codebase tree and key file imports, generate a Structurizr DSL
workspace covering Context + Container views. Use:
- person for end users
- softwareSystem for our system
- container for each deployable unit (web, api, worker, db, queue)
- explicit relationships with technology labels
Return only the DSL block.
```
- **[안티패턴]:** *(TODO: 무엇을 하면 안 되는가 + 이유 + 대신 무엇을)*
### Deployment view
```dsl
deploymentEnvironment "Production" {
deploymentNode "AWS us-east-1" {
deploymentNode "ECS Cluster" {
containerInstance api
}
deploymentNode "RDS" {
containerInstance db
}
}
}
```
## 매 결정 기준
| 상황 | Approach |
|---|---|
| 매 single-source-of-truth diagram | Structurizr DSL |
| 매 quick sketch | Mermaid / D2 직접 |
| 매 enterprise architecture | Structurizr Cloud + ADR |
| 매 OSS / public | Structurizr Lite + GitHub |
| 매 ad-hoc one-off | Excalidraw |
**기본값**: 매 production system documentation → Structurizr DSL + Lite.
## 🔗 Graph
- 부모: [[Software-Architecture]] · [[Documentation]]
- 변형: [[Mermaid]] · [[PlantUML]] · [[D2]]
- 응용: [[C4-Model]] · [[ADR]] · [[Onboarding]]
- Adjacent: [[Diagrams-as-Code]] · [[Architecture-Decision-Record]]
## 🤖 LLM 활용
**언제**: 매 codebase walk-through 후 architecture diagram 생성 (Claude 가 DSL 작성), 매 refactor plan 의 before/after view, 매 ADR 의 visual context.
**언제 X**: 매 throwaway sketch (overkill), 매 UI component design (use Figma), 매 sequence diagram primary (use Mermaid sequenceDiagram).
## ❌ 안티패턴
- **Level 4 (Code) 의 maintain**: IDE 가 더 잘함. C4 의 Code level 은 rarely worthwhile.
- **DSL 의 stale**: 매 code 와 sync 안 됨 → AI 가 quarterly regenerate.
- **Container 의 too granular**: 매 microservice 50+ 의 single view → split per bounded context.
## 🧪 검증 / 중복
- Verified (Simon Brown C4 model, structurizr.com docs, GitHub structurizr/dsl).
- 신뢰도 A.
## 🕓 Changelog
| 날짜 | 변경 |
|---|---|
| 2026-05-08 | Phase 1 |
| 2026-05-10 | Manual cleanup — DSL + CLI + Lite + AI-aided coverage |