Skip to content

Commit c408b1a

Browse files
committed
feat(documents): 문서 템플릿 추가 (#17)
1 parent 2ab7042 commit c408b1a

3 files changed

Lines changed: 50 additions & 0 deletions

File tree

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# ENTRYDSM-ADR-XXX
2+
**일자** : YYYY-MM-DD
3+
**결정자** : NAME
4+
## Context
5+
> 이 결정을 내리게 된 배경을 설명한다.
6+
> 해결하려는 문제, 제약사항(기술적·조직적), 관련 시스템, 기존 아키텍처의 한계 등을 명확히 기술한다.
7+
## Decision
8+
> 무엇을 결정했는지 한 문단으로 명확히 서술한다.
9+
> 선택한 아키텍처, 기술, 패턴, 접근 방식 등을 구체적으로 명시한다.
10+
## Alternatives Considered
11+
> 검토한 다른 선택지들을 나열한다.
12+
> 각 대안에 대해 간단한 장단점 또는 제외 사유를 함께 기록한다.
13+
## Rationale
14+
> 왜 이 결정을 선택했는지 설명한다.
15+
> 비기능 요구사항(성능, 확장성, 보안, 비용, 운영성 등)과의 연관성을 중심으로 기술한다.
16+
## Consequences
17+
> 이 결정으로 인해 발생하는 영향과 트레이드오프를 기술한다.
18+
## References
19+
> 관련 문서, RFC, 이슈, 링크 등을 나열한다.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# ENTRYDSM-AOD-XXX
2+
**일자** : YYYY-MM-DD
3+
**작성자** : NAME
4+
## Overview
5+
> 이 문서가 설명하는 시스템/서브시스템의 범위를 정의한다.
6+
> 어떤 문제 영역을 다루며, 어디까지 포함하는지 명확히 한다.
7+
## Context
8+
> 시스템이 속한 전체 환경을 설명한다.
9+
> 사용자, 외부 시스템, 상위/하위 시스템과의 관계를 기술한다.
10+
## Architecture Structure
11+
> 주요 컴포넌트와 책임을 설명한다.
12+
> 각 컴포넌트의 역할, 경계, 상호작용을 명확히 한다.
13+
## References
14+
> 관련 문서, RFC, 이슈, 링크 등을 나열한다.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# ENTRYDSM-DMD-XXX
2+
**일자** : YYYY-MM-DD
3+
**작성자** : NAME
4+
## Overview
5+
> 데이터 모델의 목적과 적용 범위를 설명한다.
6+
> 어떤 도메인과 시스템을 위한 모델인지 명시한다.
7+
## Core Entities
8+
> 핵심 엔티티 목록을 나열한다.
9+
> 각 엔티티의 책임과 의미를 간단히 설명한다.
10+
## Relationships
11+
> 엔티티 간 관계를 설명한다.
12+
> 1:N, N:M 관계, 소유 관계, 의존성을 명확히 한다.
13+
## Constraints & Rules
14+
> 데이터 무결성 규칙과 제약조건을 기술한다.
15+
> 유니크 제약, 참조 무결성, 삭제/변경 규칙 등을 포함한다.
16+
## References
17+
> ERD, 관련 ADR, 스키마 정의, 마이그레이션 문서 링크 등을 나열한다.

0 commit comments

Comments
 (0)