feat: Wiki 지식 자산 업데이트 - UX Scenarios, Frontend, Game Design, Topics 추가 [2026-05-08]
This commit is contained in:
@@ -1,20 +1,33 @@
|
||||
---
|
||||
category: Unified
|
||||
tags: [auto-consolidated, technical-documentation]
|
||||
id: wiki-2026-0508-executable-documentation
|
||||
title: Executable Documentation
|
||||
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-consolidated, 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
|
||||
---
|
||||
|
||||
# Executable Documentation
|
||||
|
||||
## 📌 Brief Summary
|
||||
## 📌 한 줄 통찰 (The Karpathy Summary)
|
||||
Executable Documentation(실행 가능한 문서)은 시스템의 기대 동작을 명시함과 동시에 실제 코드로 실행되어 검증될 수 있는 형태의 문서를 의미합니다 [1]. 소스 코드 생태계에서는 주로 '테스트 코드(Test Code)'가 가장 신뢰할 수 있는 실행 가능한 문서의 역할을 수행합니다 [1]. 이 외에도 기계가 읽을 수 있는 API 명세 기반의 대화형(Interactive) 문서나 코드로 작성되어 버전 관리가 가능한 다이어그램(Diagrams as Code) 등 코드의 변경과 실시간으로 동기화되는 문서 체계도 이에 해당합니다 [2, 3].
|
||||
|
||||
---
|
||||
|
||||
실행 가능한 문서는 소프트웨어 시스템의 기대 동작을 명확히 명시하는 신뢰할 수 있는 수단으로, 대표적으로 '테스트 코드'를 의미합니다 [1, 2]. 새로운 코드베이스를 탐색할 때 테스트 코드는 코드가 시스템에서 어떻게 사용되어야 하는지를 보여주는 훌륭한 무료 사용 설명서 역할을 합니다 [3]. 개발자는 이러한 테스트 코드를 통해 개별 컴포넌트의 논리부터 시스템 전반의 상호작용 흐름까지 파악할 수 있습니다 [2].
|
||||
|
||||
## 📖 Core Content
|
||||
## 📖 구조화된 지식 (Synthesized Content)
|
||||
* **테스트 코드를 통한 실행 가능한 문서화:** 대규모 코드베이스에서 테스트 코드는 시스템의 설계 철학과 기대 동작을 명시하는 가장 신뢰할 수 있는 실행 가능한 문서입니다 [1]. 개발자는 단위 테스트(Unit Test)를 통해 개별 컴포넌트의 국소적 논리를 이해하고, 통합 테스트(Integration Test)를 통해 시스템 전반의 상호작용 흐름을 파악할 수 있습니다 [4].
|
||||
* **동적 동작 관찰과 기술적 통찰:** 새로운 시스템에 온보딩하거나 코드를 분석할 때, 정적인 독해만으로는 시스템의 전체를 파악하기 어렵습니다 [4, 5]. 테스트 코드에서 특정 값을 임의로 변경해 보고 시스템의 반응을 관찰하는 실험적 접근은, 문서 읽기만으로는 얻을 수 없는 깊은 기술적 통찰을 제공합니다 [4].
|
||||
* **API 명세 기반의 문서 자동화:** API-First 아키텍처 환경에서는 OpenAPI나 AsyncAPI와 같은 명세(Specification)를 통해 서버 스텁, 클라이언트 SDK 및 대화형 문서를 사양 파일에서 직접 자동 생성할 수 있습니다 [2, 6]. 이 과정은 수동 작업의 노력을 줄이고 시스템 변경 시 문서가 낙후되는 것을 방지합니다 [2].
|
||||
@@ -27,7 +40,7 @@ Executable Documentation(실행 가능한 문서)은 시스템의 기대 동작
|
||||
* **실험적 접근을 통한 동적 통찰:** 정적인 독해만으로는 코드베이스를 깊이 있게 파악하기 어렵습니다 [2]. 테스트 코드 내에서 특정 값을 인위적으로 변경해 보고 시스템의 반응을 관찰하는 실험적인 접근 방식은 시스템 동작에 대한 깊은 기술적 통찰을 제공합니다 [2].
|
||||
* **온보딩과 학습의 도구:** 복잡한 시스템에 새롭게 합류했을 때, 단순히 코드를 눈으로 읽는 것을 넘어 일부 테스트를 추가하거나 변경해 보는 행위는 코드가 실제로 어떻게 작동하는지를 체득하는 데 매우 효과적인 방법입니다 [4].
|
||||
|
||||
## ⚖️ Trade-offs & Caveats
|
||||
## ⚠️ 모순 및 업데이트 (Contradictions & Updates)
|
||||
소스에 "Executable Documentation" 자체에 대한 직접적이고 포괄적인 제약 사항 정보가 부족합니다. 다만, 소스에서 다루는 실행 가능한 문서의 구체적 구현체(테스트 코드, 도구화된 문서 등)와 관련된 부작용 및 제약 사항은 다음과 같습니다:
|
||||
|
||||
* **테스트 스위트의 복잡성 및 유지보수 부담:** 테스트 코드를 논리적 구조로 그룹화(Test Suites)하여 실행 가능한 문서로 사용할 때, 과도하게 조직화하면 각각이 하위 테스트 집합을 포함하게 되어 유지보수가 매우 어려워질 수 있습니다 [8].
|
||||
@@ -42,7 +55,7 @@ Executable Documentation(실행 가능한 문서)은 시스템의 기대 동작
|
||||
* 프로젝트가 커짐에 따라 테스트 파일들을 모듈 타입에 맞춰 너무 파편화하여 분리해두면, 모듈 간의 상호작용을 테스트하는 통합 테스트 과정이 매우 복잡해져 전체 맥락을 잃기 쉽습니다 [6].
|
||||
* 과도하게 얽힌 불필요한 테스트 스위트들의 묶음은 유지보수를 매우 어렵게 만들고, 테스트 실행의 논리적 시퀀스를 맞추는 데 불필요한 복잡성을 더할 수 있습니다 [5, 7].
|
||||
|
||||
## 🔗 Knowledge Connections
|
||||
## 🔗 지식 연결 (Graph)
|
||||
### Related Concepts
|
||||
|
||||
#### [테스트 및 검증 기반 기술]
|
||||
@@ -120,3 +133,52 @@ Executable Documentation(실행 가능한 문서)은 시스템의 기대 동작
|
||||
|
||||
---
|
||||
*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