221001 문서 문서 문서

https://youtu.be/rdpBZ5_b48g

9월이 끝났다 이것이다.... 벌써 10월
나를 깨워줘~~

문서 문서 문서

문서화의 중요성을 깨달았다 ㅎㅎ...
오늘 저녁에 예전 프로젝트들을 가지고 멘토링을 받았는데, 예전에 (라고 해봤자 6월경...) 작성한 프로젝트들 코드를 다시 읽어보니 왜 이렇게 짰는지 명확하지 않다는 생각이 들었다
고작 4개월 전에 작성한 프로젝트임에도 불구하고 말이다

그 당시에는 뭔가 만들고 싶은 게 있어서 자체 해커톤 느낌으로 2~3일동안 빠르게 구현했었는데, 지금 돌아보니 설계도, 기록도, 계획도 없는 것이다
단지 타입스크립트와 리액트만 가지고 빠르게 구현만 한 결과물...

요즘 문서화와 구현 사이에서 마음이 많이 갈팡질팡했는데, 꾸준한 기록과 간단하게나마 남기는 설계는 중요하다고 확신을 갖게 되었다
배포된 프로젝트를 보니 어디에서 났을지 모를 버그 때문에 오류가 발생하는 상황인데, 단기간 빠르게 구현을 하다 보니 브랜치도 분리하지 않고, 이슈나 마일스톤으로 구현 순서를 차근차근 정리하지도 않은 채로 main에 모든 결과를 밀집시키다 보니 빠른 디버깅이 전혀 안 되는 상태이다
부스트캠프나 42를 하느라 프로젝트에 신경을 거의 못 쓴 것도 있지만...

그 당시에는 꽤 잘 짠 것 같아 뿌듯했지만 돌이켜 보니 아쉬움이 많이 남는다
그것도 구현부가 아닌 문서화 면에서 너무나 아쉬운 프로젝트인 것... 🥲 문서화와 설계의 중요성을 알았더라면 프로젝트 코드를 다시 하나하나 파악할 필요 없이 빠르게 디버깅이 가능하지 않았을까
부스트캠프를 진행하면서 문서화의 중요성을 깨닫고 뒤돌아보니 문서화 없이 구현만 덕지덕지 한 많은 프로젝트가 아른거린다 😶‍🌫️

코드 짜는 건 재밌어서 열중해서 하지만, 문서화는 잘 안 하는 경향이 있다는 멘토님 말씀을 상기하며... 언젠가 밀린 토이 프로젝트 문서 작업을 (늦게나마) 해봐야겠다
버그가 발생한 김에 다음 배포나 리팩토링을 위해서라도...