API 명세서
API 명세서는 크게 ~ 해라 고 말씀드릴 만한 사항은 X
테이블 명세서
공통 필드는 Audit 로 정의,
설명이나 데이터 타입 필드명 잘 적음
검색이 필요한 경우, 조회 속도가 빨라지려면 인덱스가 필요
어디에 인덱스를 달아야 할지 테이블 명세서에 명시해두면 더 좋음 (필드 옆에 표시)
ERD 명세서
제안 : 색상 별로 어떤 도메인이 어디에 위치하는지 표시하면 좋을 것 같다
인프라 설계도
이전 피드백이 이미 반영된 것 같다
어떤 곳은 Git Actions로 CI/CD 까지 고려해뒀는데, 가능하면 살짝 고려까지 해보면 좋을 것 같다 !
정리
테이블 명세서 → 인덱스 설정
ERD → 도메인 별로 색상 표시