Skip to content

도메인 인터페이스 문서 정합성 정리 #41

Description

@JonPark0

문제 1. 섹션 2 표 복붙 오류

"도메인 간 참조 관계" 표에서 follows, chat_room_members, messages 행의 "현재 구현" 칸이 전부 PostLikes.xxx로 잘못 표기됨.

잘못된 표기 올바른 표기
follows PostLikes.follower_id, PostLikes.following_id Follows.follower_id, Follows.following_id
chat_room_members PostLikes.room_id, PostLikes.user_id ChatRoomMembers.room_id, ChatRoomMembers.user_id
messages PostLikes.room_id, PostLikes.sender_id Messages.room_id, Messages.sender_id

문제 2. 섹션 4 follows/social 제공 API 표 누락

각 도메인이 열어줄 경계 API 초안 표에 follows/social 도메인 항목이 비어있음. users/posts/media/posts-feed는 있으나 social(팔로우)만 없음.

문제 3. "네이밍 규칙 적용 완료" 서술이 사실과 다름

섹션 3-C에 "domain 엔티티는 적용 완료"라고 되어 있으나, 실제로는 User/Post/PostMedia 3개만 카멜케이스이고 PostLikes/PostComments/Follows/ChatRooms/ChatRoomMembers/Messages 6개는 스네이크케이스 필드(post_id, created_at 등) 유지 중.

해결 방안

  • 섹션 2 표기 오류 3건 수정
  • 섹션 4에 follows/social 제공 API 표 작성
  • 섹션 3-C 서술을 실제 상태에 맞게 수정
  • 섹션 5(결정 로그) 채우기
  • 확정본을 docs/domain-interface.md로 레포에 커밋

체크리스트

  • 섹션 2 표기 오류 수정
  • 섹션 4 follows/social 표 작성
  • 섹션 3-C 서술 수정
  • 섹션 5 결정 로그 채우기
  • docs/domain-interface.md로 커밋

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions