README

Overview

테크 스펙에 대한 설명을 담고 있는 문서입니다.

아래 내용에 대한 첨삭은 자유롭게 진행합니다.

다만 기존의 내용은 삭제하지 않고 추가하는 방식으로 진행해주세요.

---

테크 스펙은 핵심은 다른 사람이 이해할 수 있도록 설명하는 것입니다.
어떤 기능에 대한 내용을 작성하든지 타인의 입장에서 이 기능에 대해 이해할 수 있도록 노력바랍니다.
테크 스펙은 아래 내용이 가장 핵심입니다.

• 어떤 기능을 구현하는지 (기능 설명)
  • 최대한 간략하게 적어도 좋습니다.
  • 최대 5줄 안팍으로 개요의 내용을 적어주세요.
• 왜 그 기능이 필요한가 (필요성)
  • 본인이 보는게 아닌 타인이 이 기능에 대한 이해를 위한 내용입니다.
  • 서버 개발자뿐만 아니라 다른 직군의 사람도 이해할 수 있도록 적어주세요.
  • 이 기능이 왜 필요한지에 대한 이유를 적어주세요.
  • 필요성을 설명할 때는 기술적인 관점과 비즈니스 또는 사용자 경험의 관점 양쪽 모두를 고려하는 것이 좋습니다
    • 이 기능이 없을 때 발생할 수 있는 문제점"을 제시하여, 필요성을 강조하는 것이 효과적일 수 있습니다.
• 어떻게 구현할 것인가 (구현 방법)
  • 구현 방법에 대한 상세한 설명을 적어주세요.
  • 이 과정 중 고민한 부분과 그중 선택한 이유를 적어주세요.
  • 대상 예시 (형식에 구애받지 않습니다. 부분별 파트를 나눠 적어도 좋습니다.)
    • 코드의 구현
    • 성능
    • 확장성
    • 디자인패턴
  • 이 영역은 다른 모든 영역에 비해 가장 상세하게 작성해주세요.

    • 어떤 라이브러리를 사용할 것인지
    • 통신 프로토콜은 무엇을 사용할 것인지
    • 요청값과 응답값은 어떤 값을 포함할건지
    • 새로 생성되는 Recode , Dto , Entity 등의 클래스는 어떤 구조로 만들 것인지

• 어떤 부분의 도움이 필요한가 (협업 및 피드백)
  • 이 기능을 구현하는데 도움이 필요한 부분을 적어주세요.
  • 위에서 작성한 구현 방법 중 고민되는 부분을 이 영역에서 적어주세요.
  • 도움을 받으면 어떤 부분을 해결할 수 있을지 적어주세요.
  • 이때 **"구체적으로 어떤 종류의 피드백을 원하는지"**와 **"피드백을 제공할 수 있는 방법"**에 대한 안내를 추가하면 좋습니다.

---

모든 작업의 테스크는 이 문서를 작성하고 난 뒤 이슈와 함께 등록되는 것을 원칙으로 합니다.

다만 예외적으로 hotfix,docs 등의 작은 큐모의 작업은 이 문서를 작성하지 않아도 됩니다.

---

작성 예시는 해당 문서를 확인해주세요.