SamProject/sam-docs
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
bcb8bb26b32c7dcf21b2c489da45b318635a394d
sam-docs/rules/README.md

27 lines
918 B
Markdown
Raw Normal View History

docs: 규칙 및 원칙 문서 체계 추가 - standards/ 폴더 추가 (코딩 규칙: 네이밍, 스타일) - rules/ 폴더 추가 (비즈니스 규칙: 검증, 도메인 로직) - principles/ 폴더 추가 (설계 원칙: 아키텍처, API 설계) - INDEX.md에 규칙 및 원칙 섹션 추가 - 각 폴더에 README.md 생성
2025-12-05 17:57:47 +09:00
# Rules (비즈니스 규칙)
docs: 문서 폴더 구조 대폭 재정리 폴더 재구성: - reference/ → standards/, architecture/, quickstart/로 분리 - principles/ → architecture/로 통합 - specs/security-policy.md → architecture/로 이동 새 구조: - standards/: 개발 표준 (어떻게 코드를 작성할 것인가) - architecture/: 아키텍처 & 설계 원칙 (왜 이렇게 설계하는가) - rules/: 비즈니스 규칙 (무엇이 유효한 데이터인가) - specs/: 기술 스펙 (무엇을 구현할 것인가) - guides/: 구현 가이드 (어떻게 구현할 것인가) - quickstart/: 빠른 시작 INDEX.md 개선: - 작업별 필수 문서 테이블 추가 - 폴더별 문서 목록 및 필수 확인 시점 명시 - 폴더 선택 기준 가이드 추가
2025-12-05 21:43:29 +09:00
> 도메인 로직에서 파생된 규칙 - **"무엇이 유효한 데이터/상태인가"**
docs: 규칙 및 원칙 문서 체계 추가 - standards/ 폴더 추가 (코딩 규칙: 네이밍, 스타일) - rules/ 폴더 추가 (비즈니스 규칙: 검증, 도메인 로직) - principles/ 폴더 추가 (설계 원칙: 아키텍처, API 설계) - INDEX.md에 규칙 및 원칙 섹션 추가 - 각 폴더에 README.md 생성
2025-12-05 17:57:47 +09:00
## 목적
- 비즈니스 로직의 명확한 문서화
- 개발 시 규칙 기반 구현 가이드
- 검증 로직의 근거 제공
## 포함 내용
- 품목코드 생성 규칙
- 필드 검증 규칙
- 상태 전이 규칙
- 권한/접근 제어 규칙
- 데이터 무결성 규칙
## 문서 목록
docs: 문서 폴더 구조 대폭 재정리 폴더 재구성: - reference/ → standards/, architecture/, quickstart/로 분리 - principles/ → architecture/로 통합 - specs/security-policy.md → architecture/로 이동 새 구조: - standards/: 개발 표준 (어떻게 코드를 작성할 것인가) - architecture/: 아키텍처 & 설계 원칙 (왜 이렇게 설계하는가) - rules/: 비즈니스 규칙 (무엇이 유효한 데이터인가) - specs/: 기술 스펙 (무엇을 구현할 것인가) - guides/: 구현 가이드 (어떻게 구현할 것인가) - quickstart/: 빠른 시작 INDEX.md 개선: - 작업별 필수 문서 테이블 추가 - 폴더별 문서 목록 및 필수 확인 시점 명시 - 폴더 선택 기준 가이드 추가
2025-12-05 21:43:29 +09:00
docs: 규칙 및 원칙 문서 체계 추가 - standards/ 폴더 추가 (코딩 규칙: 네이밍, 스타일) - rules/ 폴더 추가 (비즈니스 규칙: 검증, 도메인 로직) - principles/ 폴더 추가 (설계 원칙: 아키텍처, API 설계) - INDEX.md에 규칙 및 원칙 섹션 추가 - 각 폴더에 README.md 생성
2025-12-05 17:57:47 +09:00
| 문서 | 설명 |
|------|------|
docs: 품목 정책 통합 문서 생성 및 중복 문서 정리 - rules/item-policy.md 생성 (4개 문서 통합) - 품목 유형 체계 (FG/PT/SM/RM/CS) - 필드 키 예약어 정책 - API 파라미터 규칙 - 구현 현황 정리 - 삭제된 문서: - plans/items-api-unified-plan.md - specs/ITEM-MASTER-INDEX.md - specs/item-master-field-integration.md - specs/item-master-field-key-validation.md - 업데이트: - INDEX.md: 품목관리 필수 문서 변경 - rules/README.md: item-policy.md 추가
2025-12-09 22:11:26 +09:00
| [item-policy.md](item-policy.md) | 품목 정책 (유형 체계, 예약어, API 규칙) |
docs: plans 폴더 추가 및 HR API 규칙 문서 정리 - plans/ 폴더 신규 생성 (개발 계획 임시 문서용) - hr-api-react-sync-plan.md를 specs → plans로 이동 - INDEX.md 업데이트 (폴더 구조, 워크플로우) - rules/ HR API 규칙 문서 추가 (employee, attendance, department-tree) - pricing API 요청 문서 업데이트
2025-12-09 14:44:39 +09:00
| [pricing-policy.md](pricing-policy.md) | 단가 정책 (원가/판매가 계산, 리비전 관리) |
docs: 규칙 및 원칙 문서 체계 추가 - standards/ 폴더 추가 (코딩 규칙: 네이밍, 스타일) - rules/ 폴더 추가 (비즈니스 규칙: 검증, 도메인 로직) - principles/ 폴더 추가 (설계 원칙: 아키텍처, API 설계) - INDEX.md에 규칙 및 원칙 섹션 추가 - 각 폴더에 README.md 생성
2025-12-05 17:57:47 +09:00
docs: 문서 폴더 구조 대폭 재정리 폴더 재구성: - reference/ → standards/, architecture/, quickstart/로 분리 - principles/ → architecture/로 통합 - specs/security-policy.md → architecture/로 이동 새 구조: - standards/: 개발 표준 (어떻게 코드를 작성할 것인가) - architecture/: 아키텍처 & 설계 원칙 (왜 이렇게 설계하는가) - rules/: 비즈니스 규칙 (무엇이 유효한 데이터인가) - specs/: 기술 스펙 (무엇을 구현할 것인가) - guides/: 구현 가이드 (어떻게 구현할 것인가) - quickstart/: 빠른 시작 INDEX.md 개선: - 작업별 필수 문서 테이블 추가 - 폴더별 문서 목록 및 필수 확인 시점 명시 - 폴더 선택 기준 가이드 추가
2025-12-05 21:43:29 +09:00
## 관련 폴더
- [standards/](../standards/) - 개발 표준 (어떻게 코드를 작성할 것인가)
- [architecture/](../architecture/) - 설계 원칙 (왜 이렇게 설계하는가)
- [specs/](../specs/) - 기술 스펙 (무엇을 구현할 것인가)
Reference in New Issue Copy Permalink