사실 이력서 작성편(1)
을 작성하고 김멘토님께 이력서 양식 건으로 한차례 피드백을 더 받았었는데, 그 당시 과제 제출하는데 정신이 가출한 나머지 벨로그 작성을 깜빡했다...😱
당시 김멘토님께 드린 질문은 다음과 같다.
프로젝트를 기술 기반으로 문서화 한다는 것은 무엇인가요?
여러 예시들을 보여 주시면서 설명해 주셨는데 결국 정리하면 다음과 같다.
[ 기술문서 구성 ]
이후 위 세 키워드를 중심으로 이전 프로젝트들을 한번 정리했었는데, 놀랍게도 없는 자료들이 꽤 있었다..(어떻게 개발한거야...)
다음 프로젝트 때는 기술문서를 차근차근 정리하면서 진행해야겠다.
오늘은 기술문서 정리한 것을 피드백 받기 위해 오멘토님과 멘토링을 진행했다. 오멘토님은 프로젝트를 일일이 까보면서 리뷰해 주셨고 정리하면 다음과 같다.
리드미 어디갔어?
리드미가 없는 프로젝트가 있었다.정확히는 wiki에만 있었다. 멘토님께선 리드미에 항상 이게 무슨 프로젝트인지 있어야 한다고 하셨다.(반성타임)
커밋 히스토리 관리를 안했네?
미래의 내가 보기 위해서 커밋 로그를 남기는거다. 커밋 로그에서 평소 개발 습관이 다 들어난다.
또 글로벌 프로젝트도 아닌데 왜 영어로 커밋 로그를 써?(과거의 나 왜 그랬니) 한국어로 써.
커밋 컨벤션으로 앞에 feat, fix이런거 꼭 필요한거야? 커밋 제목에 몇자 못쓰는데 그걸 감안할 정도로 중요한거야?(본인은 일단 커밋 내용물 부터가 굉장히 실하지 못했음) 왜 쓰는지 알고 써야해.
이력서에 올릴 코드들은 리팩토링 해야 해.
코드 보면서 불편한 포인트들이 많다.
깨작깨작한 코드 밖에 없네?
로그를 깃에 왜 올려?
(그져.. 모니터링 툴로 했어야 했는데..)
그리고 println으로 터미널에 찍지 말고 slf4j로 로그 찍어라.
협업 툴을 이용했 지만 협업을 안했군..
(내가 짜지 않은 코드에 대한 이해가 전혀 없었던 상황)
참고 자료는 한국어인데 설명은 왜 다 영어야?
(외국인 개발자 친구에게 피드백을 받기 위해 기술문서를 전부 영어로 작성했던 상황) 하나만 해...번역기 돌리면 되니까.
✒총평
🦾 To do
저는 멘토님이 내주신 과제