S.A (Starting Assignments) : 프로젝트 시작 전 작성할 문서

주문 관리 플랫폼 프로젝트 시작 전 API 명세서, 테이블 명세서,ERD명세서,인프라 설계서 작성을 했습니다.

API 명세서

API 명세서란?
API의 사용 방법, 요청 및 응답 형식, 엔드포인트, 인증 방식 등을 정의한 문서입니다. 개발자들이 API를 효율적으로 사용하고 유지보수할 수 있도록 돕습니다.

✅ API 명세서를 개발 전에 작성하면 좋은 점
원활한 협업 → 백엔드·프론트엔드 간 API 형식을 미리 정의해 혼선 방지
개발 속도 향상 → 프론트는 목업 데이터 활용 가능, 불필요한 커뮤니케이션 감소
테스트 및 문서화 용이 → 자동화 테스트 작성 가능, 유지보수 쉬움
일관된 API 디자인 유지 → HTTP 메서드·응답 형식 통일, RESTful 원칙 준수
변경 사항 관리 용이 → API 변경 이력 추적 가능, 버전 관리 용이
외부 연동 준비 → 클라이언트·외부 개발자가 사전 분석 및 테스트 가능

➡ 결론: 협업 원활✅ 개발 속도 향상✅ 유지보수 편리✅ 확장성 증가✅
한사랑 코딩회의 API 명세서 링크를 첨부합니다.
https://spiky-golf-745.notion.site/API-198a1939e26e80e1bdc8e205c6595bbc?pvs=4

 

 테이블 명세서

테이블 명세서란 ?
데이터베이스의 테이블 구조를 문서화한 문서로, 각 테이블의 컬럼, 데이터 타입, 제약 조건 등을 정의합니다. 데이터 모델을 체계적으로 설계하고, 개발자 및 DBA 간 원활한 협업을 돕습니다.


✅ 테이블 명세서 작성의 장점
DB 설계 일관성 유지 → 테이블 구조를 표준화하여 혼란 방지
개발·운영 협업 원활 → 개발자·DBA·기획자가 쉽게 이해 가능
데이터 무결성 보장 → 제약 조건을 명확히 정의하여 오류 방지
확장 및 유지보수 용이 → 변경 사항 관리 및 신규 기능 추가 시 유용
➡ 결론: 체계적인 데이터 관리와 효율적인 협업을 위해 필수! ✅
한사랑 코딩회의 테이블 명세서 링크를 첨부합니다.
https://spiky-golf-745.notion.site/198a1939e26e801cb6b6fb3e123366c2?pvs=4

 

 

ERD명세서

ERD 명세서란 ?
ERD(Entity-Relationship Diagram) 명세서는 데이터베이스의 테이블 간 관계를 정의하고 시각적으로 표현한 문서이다.ERD를 통해 데이터 모델을 한눈에 파악하고, 테이블 간 관계를 명확히 이해할 수 있다.

✅ERD 명세서 작성의 장점
데이터 구조 시각화 → 복잡한 테이블 관계를 한눈에 이해 가능
DB 설계 오류 예방 → 데이터 중복, 무결성 문제 사전 방지
개발·운영 협업 원활 → 기획·백엔드·DBA 간 원활한 의사소통 가능
확장 및 유지보수 용이 → 신규 기능 추가 및 DB 수정 시 참고 가능
➡ 결론: 효율적인 데이터베이스 설계와 원활한 협업을 위해 필수! ✅

한사랑 코딩회 ERD 명세서 이미지 첨부합니다.

인프라 설계서

인프라 설계서란 ?
시스템이 운영될 서버, 네트워크, 데이터베이스, 보안 정책 등의 인프라 구조를 정의한 문서이다. 어떤 기술과 자원을 활용하여 애플리케이션을 배포·운영할지 명확하게 설계하는 데 사용된다.

✅인프라 설계서 작성의 장점
시스템 안정성 확보 → 장애 발생 시 대응을 쉽게 할 수 있음
보안 강화 → 네트워크 및 인증 정책을 명확히 정의 가능
확장성 고려 → 트래픽 증가 시 유연한 확장 가능
개발·운영 협업 원활 → 개발팀, DevOps, 보안팀 간 원활한 의사소통 가능
➡ 결론: 안정적이고 확장 가능한 인프라 운영을 위해 필수! ✅

한사랑 코딩회 인프라 설계서 이미지 첨부합니다.