[G1-Sync] Manual knowledge update
This commit is contained in:
@@ -1,119 +1,175 @@
|
||||
---
|
||||
id: wiki-2026-0508-modern-engineering-practices-현대적
|
||||
title: Modern Engineering Practices (현대적 엔지니어링 프랙티스)
|
||||
title: "Modern Engineering Practices (현대적 엔지니어링 프랙티스)"
|
||||
category: 10_Wiki/Topics
|
||||
status: needs_review
|
||||
status: verified
|
||||
canonical_id: self
|
||||
aliases: []
|
||||
aliases: [Modern Engineering, Modern Dev Practices, 현대 엔지니어링, Engineering Best Practices 2026]
|
||||
duplicate_of: none
|
||||
source_trust_level: A
|
||||
confidence_score: 0.92
|
||||
tags: [uncategorized]
|
||||
verification_status: applied
|
||||
tags: [engineering, devops, ci-cd, dora, sre, observability, ai-augmented, trunk-based, iac]
|
||||
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
|
||||
tech_stack: { language: any, framework: github-actions|terraform|opentelemetry }
|
||||
---
|
||||
|
||||
# [[Modern Engineering Practices (현대적 엔지니어링 프랙티스)|Modern Engineering Practices (현대적 엔지니어링 프랙티스]]
|
||||
# Modern Engineering Practices (현대적 엔지니어링 프랙티스)
|
||||
|
||||
## 📌 한 줄 통찰 (The Karpathy Summary)
|
||||
현대적 엔지니어링 프랙티스는 애자일(Agile) 철학을 바탕으로 개발 속도, 품질, 그리고 인프라 관리의 효율성을 극대화하기 위한 구체적인 방법론들의 모음입니다. Extreme Programming(XP)에서 파생된 짝 프로그래밍(Pair Programming)을 통해 실시간 피드백 루프를 형성하고, 기능 플래그(Feature Flags)를 활용해 코드 배포와 기능 노출을 분리하며, 코드 기반 인프라(IaC)를 통해 서버 및 환경 구성을 자동화합니다 [1, 3]. 이러한 프랙티스들은 코드 리뷰를 단순한 '사후 검사'에서 '지속적이고 선제적인 품질 보증' 프로세스로 전환합니다.
|
||||
> 한 줄: 2026년 표준 — 작은 PR·trunk-based·CI/CD·IaC·observability·DORA 측정·AI-augmented dev. "고객까지 30분 안에 배포".
|
||||
|
||||
## 📖 구조화된 지식 (Synthesized Content)
|
||||
* **XP (Extreme Programming) & 동기식 협업:**
|
||||
* **짝 프로그래밍 (Pair Programming):** 두 명의 개발자가 하나의 작업에 참여하여 실시간으로 코드를 작성(Driver)하고 리뷰(Navigator)합니다 [32]. 이는 별도의 PR 대기 시간 없이 즉각적인 결함 발견과 지식 전파를 가능하게 합니다 [3].
|
||||
* **몹 프로그래밍 (Mob Programming):** 팀 전체가 참여하여 복잡한 아키텍처 결정이나 핵심 로직을 실시간으로 함께 개발하고 리뷰합니다.
|
||||
* **기능 플래그 (Feature Flags):**
|
||||
* **배포와 노출의 분리:** 코드는 메인 브랜치에 병합되어 배포되지만, 기능의 활성화 여부는 런타임에 제어합니다 [11].
|
||||
* **작은 PR 지원:** 미완성 기능도 플래그 뒤에 숨겨 안전하게 병합할 수 있으므로, 거대한 기능을 여러 개의 작은 PR로 쪼개어 리뷰받는 것을 가능하게 합니다 [13].
|
||||
* **카나리 배포 및 테스트:** 특정 사용자 그룹에게만 기능을 노출하여 프로덕션 환경에서 안전하게 테스트할 수 있습니다.
|
||||
* **코드 기반 인프라 (Infrastructure as Code, IaC):**
|
||||
* **인프라의 코드화:** 서버, 네트워크 설정을 Terraform, CloudFormation 등 코드로 관리하여 버전 제어와 자동화된 리뷰가 가능하게 합니다.
|
||||
* **일관성 보장:** 환경 구성을 수동 작업이 아닌 코드 리뷰 프로세스 내에서 검증하여 '구성 표류(Configuration Drift)'를 방지합니다.
|
||||
## 핵심
|
||||
- **Flow**: trunk-based + short-lived branch (≤1일), feature flag, 작은 PR (<400 LOC), 즉시 review, 즉시 merge.
|
||||
- **CI/CD**: 모든 PR에서 build·test·lint·security scan, 머지 즉시 staging, canary/progressive rollout (LaunchDarkly·Argo Rollouts).
|
||||
- **DORA 4 metrics**: deployment frequency, lead time for changes, change failure rate, MTTR. Elite = 다회/일·<1h·<15%·<1h.
|
||||
- **IaC**: Terraform/OpenTofu·Pulumi·Crossplane. Drift detection. GitOps (Argo CD, Flux).
|
||||
- **Observability**: 3 pillars (logs·metrics·traces) + profiles. OpenTelemetry 표준, Grafana/Datadog/Honeycomb.
|
||||
- **AI-augmented**: Copilot/Cursor/Claude Code 코드 작성·PR review·테스트 생성. SLSA·SBOM 등 supply-chain security.
|
||||
|
||||
## ⚠️ 모순 및 업데이트 (Contradictions & Updates)
|
||||
* **동기식 협업의 리소스 소모:** 짝/몹 프로그래밍은 단기적으로 두 배 이상의 인건비가 소모되는 것처럼 보일 수 있으나, 사후 버그 수정 비용과 지식 공유 효과를 고려한 장기적 ROI를 평가해야 합니다 [4].
|
||||
* **번아웃 위험:** 하루 종일 진행하는 짝 프로그래밍은 높은 정신적 피로를 유발하므로 60~90분 단위의 타임박싱(Time-boxing)이 필수적입니다 [19].
|
||||
* **기능 플래그의 기술 부채:** 사용이 끝난 플래그를 제때 제거하지 않으면 코드 복잡성이 증가하고 테스트 사각지대가 발생합니다. 플래그의 생명주기 관리가 수반되어야 합니다.
|
||||
* **IaC의 위험성:** 인프라 코드의 작은 실수는 전체 시스템의 중단이나 대규모 보안 사고(권한 과잉 부여 등)로 이어질 수 있으므로, 애플리케이션 코드보다 훨씬 엄격한 보안 리뷰가 필요합니다.
|
||||
## 결정 기준
|
||||
| 영역 | 채택 | 회피 |
|
||||
|---|---|---|
|
||||
| 브랜치 전략 | trunk-based + short branch + flag | git-flow (대형 long-lived branch) |
|
||||
| 배포 | progressive (canary 1%→10%→100%) | big-bang weekend deploy |
|
||||
| 테스트 피라미드 | unit > contract > integ > e2e | 역피라미드 (UI 무거움) |
|
||||
| Secret 관리 | Vault, SOPS, cloud KMS | env 파일 git 커밋 |
|
||||
| Infra | IaC + GitOps | 콘솔 클릭 |
|
||||
| 모니터링 | OTel + SLO 알람 | 모든 에러 페이지 |
|
||||
| Code review | < 4시간 응답, 작은 PR | 1000줄 PR |
|
||||
|
||||
## 🔗 지식 연결 (Graph)
|
||||
### Related Concepts
|
||||
* **Agile Methodologies**: XP, 스크럼 등 유연성과 반복적 피드백을 중시하는 상위 방법론입니다.
|
||||
* **[[Continuous Integration (CI)|Continuous Integration (CI]]**: 작은 단위의 빈번한 병합을 가능하게 하는 IaC와 기능 플래그의 기술적 토대입니다.
|
||||
* **Constructive Feedback**: XP 철학에서 강조하는 교육적이고 협력적인 리뷰 커뮤니케이션 방식입니다.
|
||||
* **Shift-Left Security**: IaC 리뷰를 통해 보안 설정을 개발 초기 단계에서 검증하는 전략적 연계입니다.
|
||||
## 💻 패턴
|
||||
|
||||
### Deeper Research Questions
|
||||
* 짝 프로그래밍을 통한 실시간 리뷰가 비동기 PR 리뷰에 비해 '결함 밀도(Defect Density)'와 '지식 전파 속도' 측면에서 가지는 정량적인 비교 우위는 어느 정도인가?
|
||||
* 원격 근무 환경에서 짝 프로그래밍의 인지적 피로도를 낮추고 몰입을 돕는 가상 협업 도구의 UX 설계 원칙은 무엇인가?
|
||||
* 기능 플래그가 수백 개 이상 늘어난 대규모 시스템에서, 플래그 간의 의존성 충돌과 '조합 폭발' 테스트 문제를 해결하기 위한 자동화 전략은 무엇인가?
|
||||
* IaC 코드 리뷰 시 '권한 최소 부여(Least Privilege)' 원칙 위반을 기계적으로 탐지하기 위한 정적 분석 룰셋은 어떻게 구성해야 하는가?
|
||||
* 단순 작업은 비동기 리뷰로, 복잡한 설계는 동기식(Pair) 리뷰로 배분하는 '하이브리드 리뷰 티어링(Tiered Strategy)'의 의사결정 기준은 무엇인가?
|
||||
|
||||
### Practical Application Contexts
|
||||
* **Implementation:** 복잡한 로직이나 보안 민감 기능을 개발할 때 짝 프로그래밍을 적용하여 실시간 리뷰를 수행합니다 [52].
|
||||
* **System Design:** 시스템 아키텍처에 기능 플래그 관리 라이브러리를 내장하여 배포 리스크를 제어합니다 [53].
|
||||
* **Operation / Maintenance:** 인프라 변경 시 수동 조작을 금지하고 반드시 IaC 코드 리뷰와 자동화된 파이프라인을 거치도록 운영 정책을 수립합니다.
|
||||
* **Learning Path:** 신입 사원의 첫 2주간은 시니어와 100% 짝 프로그래밍을 진행하여 팀의 코딩 표준과 엔지니어링 문화를 체득하게 합니다 [55].
|
||||
* **My Project Relevance:** 중요도와 위험도에 따라 리뷰 방식을 차별화(Tier 1: 자동화, Tier 2: 비동기, Tier 3: 짝 프로그래밍)하여 효율적인 품질 관리 체계를 구축합니다 [56].
|
||||
|
||||
### Adjacent Topics
|
||||
* **Trunk-Based Development**: 기능 플래그를 활용해 브랜치 수명을 극도로 단축시키는 고도화된 개발 워크플로우입니다.
|
||||
* **Site Reliability Engineering (SRE**: IaC와 자동화를 통해 시스템의 가용성과 복원력을 관리하는 운영 철학입니다.
|
||||
|
||||
---
|
||||
*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
|
||||
### GitHub Actions: PR + main 분리
|
||||
```yaml
|
||||
name: ci
|
||||
on:
|
||||
pull_request:
|
||||
push: { branches: [main] }
|
||||
jobs:
|
||||
test:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-node@v4
|
||||
with: { node-version: 20, cache: pnpm }
|
||||
- run: pnpm install --frozen-lockfile
|
||||
- run: pnpm lint && pnpm test --coverage
|
||||
- uses: codecov/codecov-action@v4
|
||||
deploy:
|
||||
needs: test
|
||||
if: github.ref == 'refs/heads/main'
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- run: ./scripts/deploy.sh staging
|
||||
```
|
||||
|
||||
## 🤔 의사결정 기준 (Decision Criteria)
|
||||
### Trunk-based + feature flag
|
||||
```ts
|
||||
import { useFlag } from "@/lib/flags";
|
||||
export function Checkout() {
|
||||
const newFlow = useFlag("checkout-v2", { default: false });
|
||||
return newFlow ? <CheckoutV2 /> : <CheckoutV1 />;
|
||||
}
|
||||
```
|
||||
|
||||
**선택 A를 써야 할 때:**
|
||||
- *(TODO)*
|
||||
### Terraform 모듈 + remote state
|
||||
```hcl
|
||||
terraform {
|
||||
required_version = ">= 1.7"
|
||||
backend "s3" {
|
||||
bucket = "tfstate-prod" key = "app/terraform.tfstate"
|
||||
region = "us-east-1" dynamodb_table = "tf-locks"
|
||||
}
|
||||
}
|
||||
module "api" {
|
||||
source = "./modules/service"
|
||||
name = "api" image = "ghcr.io/org/api:${var.git_sha}"
|
||||
min_replicas = 3 cpu = "500m"
|
||||
}
|
||||
```
|
||||
|
||||
**선택 B를 써야 할 때:**
|
||||
- *(TODO)*
|
||||
### OpenTelemetry instrumentation (Node)
|
||||
```ts
|
||||
import { NodeSDK } from "@opentelemetry/sdk-node";
|
||||
import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-http";
|
||||
import { getNodeAutoInstrumentations } from "@opentelemetry/auto-instrumentations-node";
|
||||
|
||||
**기본값:**
|
||||
> *(TODO)*
|
||||
new NodeSDK({
|
||||
traceExporter: new OTLPTraceExporter({ url: process.env.OTEL_ENDPOINT }),
|
||||
instrumentations: [getNodeAutoInstrumentations()],
|
||||
}).start();
|
||||
```
|
||||
|
||||
## ❌ 안티패턴 (Anti-Patterns)
|
||||
### Progressive delivery (Argo Rollouts)
|
||||
```yaml
|
||||
apiVersion: argoproj.io/v1alpha1
|
||||
kind: Rollout
|
||||
spec:
|
||||
strategy:
|
||||
canary:
|
||||
steps:
|
||||
- setWeight: 5
|
||||
- pause: { duration: 5m }
|
||||
- setWeight: 25
|
||||
- analysis: { templates: [{ templateName: success-rate }] }
|
||||
- setWeight: 100
|
||||
```
|
||||
|
||||
- **[안티패턴]:** *(TODO: 무엇을 하면 안 되는가 + 이유 + 대신 무엇을)*
|
||||
### SLO 정의 (Prometheus)
|
||||
```yaml
|
||||
- alert: APILatencyBudgetBurn
|
||||
expr: (1 - histogram_quantile(0.99, rate(http_request_duration_seconds_bucket[5m]))/0.3) < 0.5
|
||||
for: 10m
|
||||
annotations: { summary: "P99 latency burn rate" }
|
||||
```
|
||||
|
||||
### Pre-commit + secret scan
|
||||
```yaml
|
||||
# .pre-commit-config.yaml
|
||||
repos:
|
||||
- repo: https://github.com/gitleaks/gitleaks
|
||||
rev: v8.21.0
|
||||
hooks: [{ id: gitleaks }]
|
||||
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||
rev: v5.0.0
|
||||
hooks: [{ id: trailing-whitespace }, { id: end-of-file-fixer }]
|
||||
```
|
||||
|
||||
### AI-augmented PR review (Claude/Copilot)
|
||||
```yaml
|
||||
# GitHub Action에서 PR diff → LLM review
|
||||
- uses: anthropics/claude-code-action@v1
|
||||
with:
|
||||
anthropic-api-key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||
prompt: "Review for bugs/security/perf, suggest tests"
|
||||
```
|
||||
|
||||
## 🔗 Graph
|
||||
- 상위: [[Software-Engineering]] · [[DevOps]] · [[SRE]]
|
||||
- 관련: [[CI-CD]] · [[Trunk-Based-Development]] · [[GitOps]] · [[Terraform]] · [[OpenTelemetry]] · [[DORA]] · [[Feature-Flags]] · [[Progressive-Delivery]] · [[SLSA]] · [[Code-Review]]
|
||||
- AI 결합: [[AI-Augmented-Development]] · [[Copilot]] · [[Cursor]] · [[Claude-Code]]
|
||||
|
||||
## 🤖 LLM 활용
|
||||
- PR 리뷰 1차 자동화, 테스트 생성, 마이그레이션 스크립트, 문서 초안.
|
||||
- runbook 생성: 알람 → LLM이 과거 인시던트 컨텍스트로 대응 가이드.
|
||||
- 위험: 보안·라이선스 검증 없이 머지 금지. 사람 review 필수.
|
||||
|
||||
## ❌ 안티패턴
|
||||
- **DORA 측정 없는 "DevOps"** — 베이스라인 없이 개선 불가.
|
||||
- **Long-lived feature branch** — merge hell. trunk + flag.
|
||||
- **모든 알람 = 페이지** — alert fatigue. SLO burn rate 알람만 페이지.
|
||||
- **수동 prod 배포** — 재현·롤백 불가. CI/CD 강제.
|
||||
- **Secret을 env 파일 커밋** — Vault·KMS·SOPS.
|
||||
- **Test 커버리지만 KPI** — gaming. mutation testing·핵심 path 우선.
|
||||
- **AI 코드 무검토 머지** — hallucination·라이선스·보안 이슈. 동일한 review 게이트.
|
||||
|
||||
## 🧪 검증 / 중복
|
||||
- 중복 후보: [[CI-CD]], [[DevOps]], [[SRE]] — 본 문서는 우산 (실천 종합), 각 페이지는 deep dive.
|
||||
- 검증: DORA 자동 수집 (Sleuth, LinearB, Faros) · SLO 대시보드 · CFR < 15%.
|
||||
|
||||
## 🕓 Changelog
|
||||
- 2026-05-08 | Phase 1 — 자동 시드.
|
||||
- 2026-05-10 | Manual cleanup — DORA·trunk-based·Terraform·OTel·Argo Rollouts·AI-augmented 패턴 정리.
|
||||
|
||||
Reference in New Issue
Block a user