문서화Documentation

문서화는 코드 내부의 주석(comment)부터 함수 설명(docstring), API 명세서, README 파일까지 다양한 형태를 포함합니다. '지금 내가 이해하는 것'을 미래의 나와 동료에게 전달하는 커뮤니케이션 행위라고 볼 수 있습니다.

바이브 코딩 환경에서는 AI가 코드를 생성하기 때문에 '내가 직접 짜지 않은 코드'가 프로젝트에 포함되는 경우가 많습니다. 이런 코드일수록 왜 이 방식을 선택했는지, 어떤 프롬프트로 생성했는지를 주석이나 문서로 남겨두면 나중에 수정할 때 큰 도움이 됩니다.

Cursor나 v0 같은 AI 도구는 기존 코드를 분석해 자동으로 주석이나 문서를 생성해주는 기능도 제공합니다. 그러나 자동 생성된 문서는 의도나 맥락이 빠질 수 있으므로, 핵심 결정 사항은 직접 보완해주는 습관이 중요합니다.