오늘 데일리 미팅에서는 새로운 기술을 공부하고 있는 중이라고 했는데 새로 오신 분들을 위해 문서화를 진행하기로 결정했다. 그래서 오늘은 Storybook과 Tailwind를 공부하며 문서화 작업을 진행했다.
어제 Storybook을 사용해봤지만, 곧 시작할 프로젝트에서는 Tailwind도 함께 사용할 예정이기 때문에, 두 기술을 함께 공부하며 문서화를 진행했다. 어제는 Storybook만 사용했기 때문에 설정하는 데 어려움이 없었지만, 이번에는 Storybook 위에서 Tailwind를 사용하는 것이어서 조금 다른 접근이 필요했는데, 이 과정에서 PostCSS와 관련된 모듈도 설치해야 했고, 공식 문서와 블로그를 참고하며 ChatGPT의 도움까지 받았다.
Storybook의 기본적인 개념을 공부하며 문서화를 진행하던 중, 점심 이후에 저희 팀이 7 버전을 사용한다는 것을 알게 되어 작성하던 문서를 수정하고 7 버전을 다시 공부했다. 다행히 큰 차이는 없었고, 특정 기능 지원이 추가되거나 코드가 더 간결해진 점만 있어서 다행이다.
퇴근할 때쯤 문서화 작업을 마치고 피드백을 받았는데, 생각보다 자세하게 작성했다고 하셔서, 세팅 같은 부분은 새로 오신 분들이 오실 때쯤에는 이미 완료되어 있을 것이기 때문에, 좀 더 간단하게 작성해도 된다고 했다.
오늘 과정 중에 내가 좀 놓쳤던 부분은 버전을 제대로 인지하지 못했고, 문서를 보는 사람의 입장을 고려하지 않았던 것 같다. 내일은 Zod, Zodios에 관해 문서화를 할 예정인데, 버전을 체크하고 세팅하는 부분 같은 경우에는 굳이 문서화 내용에 포함시키지 않아도 될 것 같다. 보는 사람 입장에서 생각한다면, 어떻게 문서화를 해야 새로 오신 분들이 봤을 때 빠르게 이 기술을 익혀서 프로젝트에 기여할 수 있겠는가라는 것을 고려해서 해봐야겠다.
그리고 chat GPT를 더 적극적으로 사용해 봐야겠다 완전히 신뢰할 수는 없지만 큰 힌트를 주는 역할로 잘 사용할 수 있을 거 같다.