api명세1 개발자 문서화 (생각 기록, 협업, 유지보수) 개발 공부를 처음 할 때 저는 코드만 잘 돌아가면 충분하다고 생각했습니다. 문서화는 시간이 남을 때 하는 부가 작업처럼 느껴졌고, README도 형식적으로 적는 정도로 봤습니다. 그런데 몇 달 뒤 제가 만든 코드를 다시 열었을 때, 왜 JWT를 선택했는지, 오류를 어떻게 해결했는지, 어떤 기준으로 구조를 잡았는지 기억나지 않아 당황했습니다. 팀 프로젝트에서도 API 명세나 실행 방법이 정리되지 않으면 같은 질문이 반복되고, 새 팀원이 적응하는 데 시간이 오래 걸렸습니다. 저는 그때 문서화가 단순한 글쓰기가 아니라 개발자의 생각과 문제 해결 과정을 남기는 일이라고 느꼈습니다. 이 글에서는 제 경험을 바탕으로 개발자가 문서화를 잘하면 얻는 장점을 정리해 보겠습니다.개발자 문서화가 내 생각을 기록하는 이유코드.. 2026. 6. 11. 이전 1 다음
