프로젝트 설계 및 문서화

IT비즈니스 프로세스

  비즈니스 프로세스는 구체화정도에 따라서 사업 - 기획- 개발의 순서로 이루어진다. 회사의 주요 의사결정자들이 사업을 결정한다. (의사결정이 존재하기때문에 이에 따른 위계질서가 존재함) 사업방향이 결정되면 기획자들과 사업자들이 해당 시장에 대한 데이터를 모으고 논의를 하면서 사업의 구체화가 이루어진다. 사업이 충분히 구체화되면 기획단계로 넘어가고, 서비스의 객체와 기능, 범위, 프로세스 등을 정의한다. 기획단계가 마무리되면 개발자단계로 넘어가고 사업기획의 기술적 관점에서 가능여부를 검토하여 기획의 세부내용을 수정한다.

 

개발명세서검토 (은행계좌생성 예제)

1.  기술스택 결정

  개발자는 내부 개발자원을 감안하여 개발언어, 기술스택, DB종류, DBdrive 등을 결정한다.

 

2. 각 기능별 구체적인 명세서 생성

 

• 사용자
  • 사용자 정보 정의
• 계좌
  • 계좌생성API
    • POST/account
    • 파라미터 : 사용자 아이디, 초기잔액
    • 정책 : 사용자가 없는 경우, 계좌가 10개(사용자당 최대 보유가능 계좌 수)인 경우 실패응답
    • 성공응답 : 사용자 아이디, 계좌번호, 등록일시
  • 계좌해지API
    • DELETE/account
    • 파라미터 : 사용자 아이디, 계좌번호
    • 정책 : 사용자 또는 계좌가 없는 경우, 사용자 아이디와 계좌 소유주가 다른 경우, 계좌가 이미 해지 상태인 경우, 잔액이 있는 경우 실패 응답
    • 성공응답 : 사용자 아이디, 계좌번호, 해지일시
• 거래정보
  • 잔액사용API
    • POST/transaction/use
    • 파라미터 : 

 

 

3. API설계

  각 기능별로 API의 method, parameter, 예외처리정책, 성공응답을 구체화한다. API 설계시에는 기획자의 제약사항들을 반영할 수 있도록 설계할 것.

•  개발환경설정 : 그 후 설계단계는 프로젝트생성, 팀내 코드 컨벤션 합의, 패키지 구조생성, DB접속정보설정, 각종 연동 API확인검토 단계로 이루어진다.
• 패키지구조는 주로 AOP, config, controller, domain, dto, exception, repository, service, type이 일반적인 구조임.

(양세열 강사님)

 

개발구조설계

  개발 다이어그램은 크게 3가지 종류가 나오게된다.

1. 도메인 협력관계 : 기획자도 이해할 수 있도록 도메인 관계를 도식화

 

 

2. 클래스 다이어그램 : 도메인 협력관계를 구체화하여 클래스를 도식화

 

 

 

 

 

3. 객체 다이어그램 : 클래스를 실제로 구현한 생성 구현체 간의 관계 도식 

 

기타

1. 정책이 미정인 상태라면 Interface만 구축한 후, Interface에 의존하고 향후 구현체를 구현하도록 하자.

2.