23-10-29 스크럼

[YangTaeyoung]

논의할 내용

• QA 스프린트 종료 버그 수정 사항 확인
  • @aiaaua : 오늘 중으로 리포팅 된 버그 모두 해결 가능
  • @YangTaeyoung : 오늘 중으로 리포팅 된 버그 모두 해결 가능
  • @SHINSOJIN : 수요일(11/3) 회의 전까지 리포팅 된 버그 모두 해결 가능
• 문서화 스프린트 시작
• 문서화 내용 정의
  • 프론트
  • 백
• 문서화 채널 결정
  • Github Discussion
  • Github Wiki
  • Github Repository
• 일정 및 문서화 작업 분배

[YangTaeyoung]

문서화 내용 정의

전체

• 멤버 리스트
  • 각 멤버 소개
  • Github, LinkedIn, email, blog 등 링크
• 총 소요기간
  • 공부
  • 개발
  • QA
  • 문서 작성
• 프로젝트 개요
• 요구사항 정의 (rough)
• 프로젝트 방식
  • 미팅
  • 컨벤션
  • 코드리뷰

사전조사

• 기술 조사
• 기술 공부

백엔드

• 아키텍처 구성도 (excalidraw, draw.io 이용해서 다이어그램 그리기)
• ERD (JetBrains에서 제공하는 툴로 export)
• 배포 시퀀스 (배포가 어떻게 이루어지는지 파이프라인 그리기)
• 사용한 기술 및 사용 근거 및 한계점
  • Spring
    • Spring Security
      • JWT
    • Spring MVC
      • RESTful API 구성
    • Spring Data JPA
  • Observability
    • 로깅 AOP 구성
    • 로깅 Filter 구성
    • Grafana 대쉬보드 구성 및 한계 (loki, prometheus 쓸 걸)
      • 시간이 걸렸던 부분 적어보기
  • Testing
    • JUnit 5
    • Testcontainers
    • Unit Test Case 과정
      • Repository Layer
      • Service Layer
  • AWS
    • AWS ECS
      • 컨테이너 구성 (Dockerfile)
    • AWS Elastic Cache
      • Redis
    • AWS RDS
      • DB
    • AWS S3
    • pre-signed url을 통한 파일 업로드
  • Github Action
    • 배포 시퀀스 및 배포 원리?
    • 테스트 커버리지 리포트가 Github PR에 나오도록 하는 것 작성 방법
  • 이메일 인증
  • 사용 기술
    • Redis
  • 이메일 인증 시퀀스 다이어그램

프론트엔드

• 사용한 기술 및 라이브러리 도입 근거
  • MUI
  • Toast UI Editor
  • AWS Amplify
• 각 페이지 별 핵심 기능 GIF 캡처
  • 다크 모드
  • TOC
  • 파일 업로드 등
  • 토큰 상태 관리
• 강조하고 싶은 구현 및 한계점
  • 토큰 관리

[YangTaeyoung]

문서화 채널

1안: 각 Repository에 모든걸 때려박기

• readme.md
  • Getting Started
    • 준비물, 서버 구동 방법 등
    • 아키텍처 구성도
    • 관련해서 문서 링크를 다다닥 달기
  • docs/
    • 관련 문서를 주제별로 포스팅

2안: 각 Repo + Wiki 조합

• readme.md
  • 준비물, 서버 구동 방법 등
    • 아키텍처 구성도
    • 관련해서 위키 링크를 다다닥 달기
• Github Wiki
  • 백, 프론트 관련해서 레포 별로 문서화 하기

3안: plog.github.io 에 블로그 개설

• Github Pages 사용
  • 모든 문서를 블로그에 문서화하기
• hugo, jekyll 등 블로그 엔진 사용
• 장점
  • Github Pages 이용해봤다고 자랑할 수 있음.
  • 본인 블로그도 만들어 볼 수 있음.
• 단점
  • 우리가 만든 블로그보다 더 예쁠거임. (대부분)
  • Google Search Engine, Naver Crawling Engine에 각각 사이트를 등록해야 함 (정적 사이트이므로)
  • 러닝커브가 있는 편

4안: 우리의 plog에 포스팅한다.

• 역할을 다하는 친구
• 단점
  • 돈: 계속 띄워놔야 해서 돈이 한달에 약 5만원 소요 예정(안띄워놓으면 2~3만원)
  • 검색이 되기 시작하면, 유입되는 사용자가 있을거라서 차단이 필요할 수 있음. (버그, 개인정보 유출 우려)

5안: 제 3의 채널 이용

• Notion
• Obsidian
• Velog
• Tistory

[YangTaeyoung]

일정 및 문서화 작업 분배

Working Day 추정 (~23-11-05)

이름	Working Day	비고
태영	4d	수, 금, 토, 일
수영	4d	화, 수, 목, 일
소진	4d	수, 목, 금, 토

작업 분배

태영

• 깃헙 블로그 세팅
• readme.md
  • Getting Started
  • 아키텍처 구성도 (excalidraw, draw.io 이용해서 다이어그램 그리기)
  • ERD (JetBrains에서 제공하는 툴로 export)
  • 배포 시퀀스 (배포가 어떻게 이루어지는지 파이프라인 그리기)

수영

• Observability
  • 로깅 AOP 구성
  • 로깅 Filter 구성
  • Grafana 대쉬보드 구성 및 한계 (loki, prometheus 쓸 걸)
  • 시간이 걸렸던 부분 적어보기
• Testing
  • JUnit 5
  • Testcontainers
  • Unit Test Case 과정
    • Repository Layer
    • Service Layer

소진

• 사용한 기술 및 라이브러리 도입 근거
  • MUI
  • Toast UI Editor
  • AWS Amplify
• 각 페이지 별 핵심 기능 GIF 캡처
  • 다크 모드
  • TOC
  • 파일 업로드 등
  • 토큰 상태 관리
• 강조하고 싶은 구현 및 한계점
  • 토큰 관리