혹시 다른 의견 있으시다면 노션 코멘트나 맨 밑에 리뷰 란에 작성해주시면 좋을 것 같애요!
https://github.com/boostcampwm2023
위 링크는 작년 네이버 부스트캠프 프로젝트가 모여진 github organization입니다!
좋은 자료들이 너무 많아서 첨부했어요!!
각 레포에 wiki 중 멘토링 일지를 잘 작성한 팀들이 있는데, 평소 고민하던 문제들에 대한 인사이트도 얻을 수 있었습니다.
기획 아이디어 얻기에도 좋을 것 같애요!!!
백엔드는 모두 Node.js이긴 합니다…
1. 문서화 - 그래서 뭐를 문서화하죠…? 왜 하죠..?
https://github.com/boostcampwm2023/web16-B1G1/wiki
참고할만한 문서화 예시입니다!
위 레포지토리는 작년 네부캠에서 다른 분들이 하신 프로젝트 입니다.
문서화가 너무 잘 되어있어 레퍼런스로 삼으면 좋을 것 같아 첨부합니다!
프로젝트 소개(README), 기술스택 소개, 컨벤션, 학습 기록, 개발 기록, 회의록 등 참고하면 좋을 것 같습니다.
멘토링 일지에서 좋은 인사이트를 얻을수도..?
문서화의 목적
- 예전에 고민하고 해결했던 문제를 다시 해결하지 못함: 개인적으로 정말 자주 겪었던 문제였습니다. 또한 새로운 기술을 적용하면서 공부를 많이 했지만, 기록으로 남겨둔게 없어 다음번에 복기하는데 오랜 시간이 걸린 경험도 있었습니다.
- 팀원의 작업 내용을 파악하기 힘듦: 다른 팀원이 PR을 올려도 코드 이해가 잘 안되어 리뷰를 제대로 하지 못한 경험이 있었습니다. PR도 작업 내용을 기록하는 문서로 잘 활용한다면 좋을 것 같았습니다. 코드리뷰 - 같이 성장하기 위한, 그리고 성공하기 위한 팀이 되기 위한 도구(김우성) 참고!
- 그 당시의 생생한 기록을 남기기 위함 → 생생한 기록을 남긴다면 이력서나 포트폴리오 작성 시 많은 내용을 담을 수 있지 않을까요?
1.1 어떤 것을 문서화 할 지?
1) 팀 문화 문서화(완료, 수정 가능)
2) 프로젝트 소개(README)