[TIL] 원티드 프리온보딩 백엔드 인턴십 Week2) 13일차, 0901

✔️ 오늘 한 일

• 기능 정상작동 확인
• README 작성

👀 오늘의 이슈

📝 README를 작성해보자

• 이번 README는 1주차 때보다 하루 일찍 작성했다.
  1주차에는 시간이 부족해 과제 마감일에 팀원들과 밤을 새워 겨우 작성했지만, 이번에는 조금 더 여유를 가지고 작업하기 위해 과제를 시작할 때부터 규칙을 추가하고, 구체적인 목표를 세워 지키려고 노력했다.
  이번 과제의 README 작성 목표일은 오늘이었고, 목표를 달성했다 ! 속이 시원하다.

---

🚩 추가한 규칙

1. 아침 회의 - 30분 / 저녁 회의 - 1시간

• 아침 회의는 기본 30분 이내로 종료, 최대 1시간 이내 엄수
• 한가지 주제로 고민하는 시간은 최소 15분 이상 넘기지 않기 ex) 투표로 빠르게 결정

2. 노션에 각자 Daily TODO 매일 작성

• 오전 9시 회의 전까지 기재
• 오후 5시 회의에 해당 TODO 바탕으로 진행사항 확인

---

📊 구체적인 목표

• 1일차 (화) : 요구사항 분석 및 ERD 1차 설계 완료하기 ✅
• 2일차 (수) : 프로젝트 생성 및 GitHub Repository 생성 후 최소 저녁부터 기능 구현 바로 시작하기 ✅
• 3일차 (목) : 담당 기능 구현 ✅
• 4일차 (금) : 담당 기능 구현 ✅
• 5일차 (토) : 토요일까지 API 구현 70% 이상 완료하기 ✅
• 6일차 (일) : 기능 정상 작동 확인 및 README 작성 ✅
• 7일차 (월) : 문서 보완 / Refactoring / 선택기능 구현 💭

---

추가적으로, 이번 README를 작성할 때 1차 과제와 달라진 점은 GitHub의 Wiki를 활용했다는 것이다.

문서가 지나치게 길어지면 보는 사람의 피로도가 증가할 수 있다는 점을 고려하여
프로젝트의 전반적인 내용은 README에 간략하게 정리하고,
기술 선택 이유, 트러블 슈팅, 고민한 흔적의 상세 내용은 Wiki에 작성하여 가독성을 높였다.

+ 모든 항목에 링크를 걸면 원본 URL을 찾기 어려워 이탈할 가능성이 높아진다.
이탈률을 줄이기 위해 이미지 등의 문서는 토글을 사용해 원래 위치에서 쉽게 확인할 수 있도록 구성했다.

💡 Today I Learned

- Postman으로 API 명세서를 작성해서 발행하면 서버가 실행되고 있지 않아도 누구나 접속 가능하다.

• 포스트맨으로 API 명세 작성하는 방법을 블로그에 정리해보았다.
  🔗 https://velog.io/@ryuneng2/Postman-포스트맨으로-명세-작성하는-방법

 

---

< 해당 글은 velog에서 이전하며 옮겨온 글로, 가독성이 좋지 않을 수 있는 점 양해 부탁드립니다. >

🔗 velog 버전 보기 : https://velog.io/@ryuneng2/TIL-원티드-프리온보딩-백엔드-인턴십-Week2-13일차-0901