template 가이드

  • h1 레벨이 (#제목) 깃북에서 나타나는 문서 제목이 됩니다.
  • 아래 가이드를 읽은 후 template.md를 복사해서 사용해주세요.
  • 가이드는 참고용이며, 필요시 얼마든지 변경해서 사용하시면 됩니다.

1. 구현 목적

  1. 어떤 것을 구현하려고 하는지 간략하개 작성해주시면 됩니다.

2. 도입 전 기술 비교 / 기존 플로우

기술을 새로 도입하는 경우 전자를, 리팩토링을 하는 경우 후자를 남기고 나머지는 삭제하시면 됩니다.

  1. 새로 기술을 도입하는 경우 비슷한 후보군에 어떤 것이 있었는지, 어떻게 비교를 했는지 근거를 작성하시면 됩니다. 결론적으로 선택한 기술도 작성해주세요.
  2. 리팩토링을 하는 경우, 기존 플로우를 먼저 설명하시면 됩니다.

3. 구현 방법

  1. 어떻게 구현했는지, 구현 시 미리 설정해야하는 것이 있는지
  2. 구현 시 주의점이 있는지 등을 자유롭게 작성해주세요
  3. 필요 시 이미지를 첨부해주세요

4. 구현 중 트러블 슈팅

트러블 슈팅에는 가능한 아래 사항을 포함해 주세요

  1. 상세한 버그 로그, 버그 발생 상황(재현이 가능한 경우 재현 과정)
  2. 버그 원인
  3. 버그 해결 방법

5. 최종 결과 플로우

  1. 결과 이미지, 결과 흐름도 등 어떻게 변화했는지, 목적을 달성한 자료를 작성해주시면 됩니다

results matching ""

    No results matching ""