가이드 소개

개발 가이드의 목적 및 가이드 변경 프로세스를 설명

목적

기능을 통합하여 중복 코드를 줄이고, 기능을 잘못 사용하면서 생기는 오류, 생산성 저하를 막는 목적

  • 같은 기능을 하는 코드가 너무 많음 : 기능이 있는 줄 모르고 또 만들거나, 작은 요구사항 변화에 신규 기능 작성
  • 잘못된 코드가 전파 : 다른 코드를 참조하여 개발하다 보니 참조한 코드에 오류가 있을경우 그대로 사용
  • 기능을 목적과 다르게 사용 하면서 문제 발생

목표

비지니스 로직이 아닌 개발 방법에 대해 개발자간 불필요한 소통 제거 중복 코드가 발생하지 않도록 한가지 문제를 해결할 수 있는 한가지 방법을 제공

  1. 공통 유틸 문서화
  2. 범용 코드 (PG 개발, 주문 취소, 단계 이동)
  3. 범용 프로세스 (향진출, ccnet 배포)

1차 목표 - 티쿤 2.0 CRUD 구현

영역 항목
DB 가능
Query 가능
DAO 페이징 처리 가이드 필요
Service 페이징 파라메터 가이드 필요
Tqoon 2.0 Controller 가능
Tqoon 2.0 Front 페이징 디렉티브 가이드 필요 / 예외 처리 가이드 필요(5월 예정) / 폼 벨리데이션 가이드 필요

가이드 작성 프로세스

  1. 이슈 선정
    • 개발하면서 필요한 안건을 담당자에게 전달
    • 가이드 담당자는 안건을 취합
  2. 담당자 할당, 가치 평가, 이슈 등록
    • 매달 개발자 1인당 1안건 할당
    • 가치 평가 회의에서 안건 설명, 가치 부여
  3. 가이드 작성
  4. 가이드 작성 완료 검토
    • 작성자는 가이드 담당자에게 풀리퀘스트 생성후 리뷰 요청
  5. 한달에 한번씩 작성 담당자가 내용 브리핑

작성 툴

Markdown 에티터

  • Visual Code
  • Typora

Jekyll 구동

  • Ruby
  • Jekyll

추가 해야할 가이드 내용

  • 표준 날짜 검색 / 쿼리 생성 가이드
  • 표준 웹 파일 처리 가이드
  • 2.0 앵귤러 코드 패턴
  • 공금사, 판매사, 입점사
  • 에러 처리 표준 가이드