Business Rule Documentation Guide

기본 원칙

• 간결하고 명확하게
• 실행 가능한 예시와 함께
• "왜"에 집중

비즈니스 로직 문서

파일: docs/domain/{도메인명}.md 또는 해당 모듈의 README.md

[도메인명]

개요

이 도메인이 다루는 비즈니스 영역 (1-2문장)

핵심 개념

[개념명]

정의: 명확한 정의

예시:

// 실제 사용 예시 코드

코드 위치: src/domain/concept.ts

비즈니스 규칙

[규칙명]

• 내용: 규칙 설명
• 이유: 왜 이 규칙이 필요한가
• 예외 (있다면): 예외 상황
• 코드 위치: src/domain/rules.ts:45-67

프로세스 흐름 (복잡한 경우만)

[프로세스명]

1. 단계 1 → src/service/step1.ts
2. 단계 2 → src/service/step2.ts
3. 단계 3 → src/service/step3.ts

주의사항 (있다면)

• 흔히 실수하는 부분
• 변경 시 주의할 점

용어집 (필요한 경우만)

• 용어1: 정의
• 용어2: 정의

문서 관리

문서 위치

project-root/
├── docs/
│   ├── work/          # 작업 가이드라인 (작업 완료 후 삭제)
│   └── domain/        # 비즈니스 로직 문서 (지속 유지)
├── WORK_SUMMARY.md    # 작업 보고서 (확인 후 즉시 삭제)
└── README.md

생명주기

• 작업 가이드라인: 작업 완료 후 삭제
• 작업 보고서: 확인 즉시 삭제
• 비즈니스 로직 문서: 코드와 함께 유지보수