📄 사용자 요구사항 정의서 & 커밋 컨벤션

💡 사용자 요구사항 정의서

목적
기존 심리상담 어플리케이션의 그룹 테라피 기능의 부재로 인한 그룹 테라피 중점 어플리케이션 개발

요구사항
ID, 요구기능, 설명, 권한, 분류, 우선순위, 요구사항

더 많은 기능을 정의했었지만 1달이라는 시간안에 모든 구현을 할 수 있을것 같지 않아,
최대한 구현 후 여유가 있을때 추가 안된 요구사항을 정의서에 다시 추가하여 구현할 것

 

사용자 요구사항 정의서
프로젝트 명	그룹 심리상담 예약 서비스 개발
단계명	구상 / 기획 단계
작성일자	2023-01-04

 

예약

요구사항ID	요구기능	설명	권한	분류	우선순위	요구사항
res-01	예약-생성	프로그램 예약	내담자	예약	상	결제가 완료 시 생성 가능
res-02	예약-취소	프로그램 예약 취소	내담자	예약	상	취소는 시작 2일전까지만 가능
res-03	예약-조회	예약 조회	내담자	예약	상

 

결제

요구사항ID	요구기능	설명	권한	분류	우선순위	요구사항
pay-01	결제	예약을 위한 결제	내담자	결제	상	외부 API(아임포트) 연동
pay-02	결제-취소	취소 후 환불	내담자	결제	상	외부 API(아임포트) 연동

 

회원

요구사항ID	요구기능	설명	권한	분류	우선순위	요구사항
user-01	회원가입	OAuth2를 통한 회원가입	전체	회원	상	가입 시, 상담사와 회원의 분류
user-02	회원탈퇴	회원 탈퇴	전체	회원	중
user-03	로그인	로그인	전체	회원	상	OAuth2+JWT  적용
user-04	로그아웃	로그아웃	전체	회원	상
user-05	회원정보 조회	마이페이지 기능	전체	회원	상
user-06	회원정보 수정	마이페이지 기능	전체	회원	상
user-07	개설 프로그램 목록 조회	본인이 개설한 프로그램 조회	상담사	회원	중
user-08	예약 조회	예약된 회원 리스트 조회	상담사	회원	중
user-09	예약 프로그램 정보 전송	예약이 완료된 프로그램에 대한 안내문 전송	상담사	회원	중

 

관리자

요구사항ID	요구기능	설명	권한	분류	우선순위	요구사항
admin-01	전체 회원 조회	등급별 조회 기능	관리자	관리	중
admin-02	결제 내역 조회	회원이 결제한 내역 조회	관리자	관리	상
admin-03	개별 프로그램 생성	요청된 상담세션에 대한 승인	관리자	관리	상
admin-04	개별 프로그램 수정	승인된 프로그램 세부사항 수정	관리자	관리	상
admin-05	개별 프로그램 삭제	프로그램 삭제	관리자	관리	상
admin-06	모든 프로그램 조회	승인된 프로그램 전체 조회	관리자	관리	상
admin-07	일반회원 전체 조회	일반회원 전체 조회	관리자	관리	하
admin-08	일반회원 개별 조회	일반회원 개별 조회	관리자	관리	하
admin-09	일반회원 상담내역 조회	일반회원 상담내역 조회	관리자	관리	중
admin-10	전체 상담사 조회	전체 상담사 조회	관리자	관리	중
admin-11	상담사 검색 조회	상담사 검색 조회	관리자	관리	중
admin-12	상담사 회원 상담내역 조회	상담사 회원 상담내역 조회	관리자	관리	중
admin-13	상담사 등록	새 상담사 등록	관리자	관리	상
admin-14	통합 결제 조회	결제내역 통홥 관리 페이지	관리자	관리	하
admin-15	결제 취소	결제 취소 페이지	관리자	관리	하

 

프로그램

요구사항ID	요구기능	설명	권한	분류	우선순위	요구사항
pro-01	상담 프로그램 전체 조회	모든 프로그램 조회	전체	상담 프로그램	상
pro-02	개별 프로그램 조회	개별 프로그램의 정보 조회	전체	상담 프로그램	상
pro-03	상담 프로그램 검색	증상별 프로그램 조회 기능	전체	상담 프로그램	상

 

커뮤니티

요구사항ID	요구기능	설명	권한	분류	우선순위	요구사항
com-01	글 생성	생성	전체	커뮤니티	중	공지(관리자만),
com-02	글 조회	조회	전체	커뮤니티	중	공지(관리자만)
com-03	글 수정	수정	전체	커뮤니티	중	공지(관리자만)
com-04	글 삭제	삭제	전체	커뮤니티	중	공지(관리자만)
com-05	전체 글 조회	전체 조회	전체	커뮤니티	중	공지(관리자만)

---

💡 커밋 컨벤션

 

태그 이름	설명
Feat	새로운 기능을 추가할 경우
Fix	버그를 고친 경우
Design	CSS 등 사용자 UI 디자인 변경
!BREAKING CHANGE	커다란 API 변경의 경우
!HOTFIX	급하게 치명적인 버그를 고쳐야하는 경우
Style	코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
Refactor	프로덕션 코드 리팩토링
Comment	필요한 주석 추가 및 변경
Docs	문서를 수정한 경우
Test	테스트 추가, 테스트 리팩토링(프로덕션 코드 변경 X)
Chore	빌드 태스트 업데이트, 패키지 매니저를 설정하는 경우(프로덕션 코드 변경 X)
Rename	파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
Remove	파일을 삭제하는 작업만 수행한 경우

 

• 변수명: camelCase
• 파일: PascalCase
• 패키지: lowercase
• 상수: UpperCase_Snake_Case
• DTO private 필드: camelCase
• 클래스 & 인터페이스: PascalCase
• 패키지 구조: 도메인 기반
• Builder 패턴 엔티티에 사용 가능
• 팩토리 메서드 사용 X
• MapStruct 사용