by Wizard

개발자들이 코드 문서화를 싫어하는 이유와 해결책: IT 관리자의 숨겨진 책임

기업 IT 부서의 고질적인 불만 중 하나는 바로 레거시 시스템, 특히 자체 개발 코드에 대한 문서 부족입니다. 이로 인해 운영이 필요 이상으로 복잡해지고 위험해지는 것이죠. 하지만 왜 이렇게 문서가 부족한지에 대한 근본적인 원인은 잘 논의되지 않습니다. 슬프게도, 그 책임은 대부분 IT 관리자, 특히 코딩이 이루어지던 당시 문서화를 소홀히 했던 관리자에게 있습니다.

문서화, 왜 이렇게 어려울까요?

개발자들이 문서화를 싫어하는 이유는 여러 가지가 있습니다. 첫째, 재미가 없다는 것입니다. 코딩은 창의적인 작업이지만, 일단 완료되면 다음 프로젝트로 넘어가고 싶어합니다. 이미 끝난 프로젝트에 매달려 모든 측면을 문서화하고 설명을 덧붙이는 것은 지루한 일이죠. 피할 수 있다면 당연히 피하고 싶을 겁니다. 둘째, 자기 보존 본능도 작용합니다. 개발자들은 문서가 없으면 관리자가 자신을 해고하거나 정리해고하기 어려워할 것이라고 생각합니다. 나중에 필요할 수도 있으니까요. 만약 개발자가 회사를 떠났다면, 문제를 해결하기 위한 컨설팅 기회를 얻을 수도 있습니다. 자세한 문서 작업은 이러한 기회를 줄어들게 만듭니다.

IT 관리자의 책임 회피

IT 관리자들은 개발자들이 다음 프로젝트로 넘어가기를 바랍니다. 앱이나 코드 수정이 완료되고 비즈니스 라인 관리자의 승인을 받으면, IT 부서는 곧바로 다음 작업으로 넘어가고 싶어하죠. 프로그래머가 하루나 그 이상을 들여 완료된 프로젝트에 대한 세부 사항을 문서화하는 것을 원하지 않습니다. 여기서 심각한 단절이 발생합니다. IT 관리자는 프로그래머가 의미 있는 문서화를 건너뛰도록 장려하면서, 18년 전에 작성된 레거시 코드에 대한 문서 부족에 대해 불평합니다. 과거의 관리자가 지금의 자신과 똑같은 행동을 했기 때문에 문서가 부족하다는 사실을 잊은 채 말이죠.

3가지 문제와 해결 방안

문제를 해결하기 위해서는 세 가지 뚜렷한 문제를 인식해야 합니다. 첫 번째는 오래전에 만들어진 코드로, 원래 개발자를 찾을 수 없는 경우입니다. 두 번째는 비교적 최근에 만들어진 코드로, 원래 개발자를 찾을 수 있는 경우입니다. 세 번째는 현재 개발자들이 작성하고 있는 코드입니다.

젠AI, 해결책이 될 수 있을까?

젠AI 코딩 도우미가 도움이 될 수 있을까요? 개발자들이 단순히 "지루해서 하기 싫다"고 생각한다면 AI 도구가 큰 차이를 만들 수 있습니다. 하지만 개발자들의 자기 보존 본능은 여전합니다. 그들은 단순히 문서화를 '하기 싫어하는' 것이 아니라, '누군가에 의해' 문서화되는 것 자체를 싫어합니다. IT 관리자는 AI가 문서화를 해준다면 개발자들이 다음 프로젝트로 넘어갈 수 있기 때문에 괜찮다고 생각할 수 있습니다. 하지만 AI가 사후에 코더의 의도를 추측하는 방식은 오히려 더 많은 문제를 일으킬 수 있습니다. AI 에이전트가 모든 코딩 과정을 이해하기 위해 개발자와 협력해야만 문제를 해결할 수 있습니다. 하지만 개발자는 자신의 일자리를 잃지 않기 위해 협력에 적극적이지 않을 수 있습니다.

문서화 문제, 근본적인 해결책은?

IDC의 애널리스트인 Adam Resnick은 문서화 문제가 기업 IT의 끊임없는 고민거리라고 지적합니다. 그는 "부실한 문서화는 레거시 시스템의 현대화를 어렵게 하고, 온보딩, 보안 감사, 버그 해결 및 유지보수를 더욱 어렵게 만든다"고 말합니다. Resnick은 이 문제를 IT 우선순위의 문제로 봅니다. 기업은 새로운 기능 제공이나 긴급한 버그 수정에 높은 우선순위를 두고 개발자들은 이러한 목표를 향해 인센티브를 받습니다. 결국 개발자들은 문서화가 지루하고 불필요하다고 생각하게 됩니다. 좋은 코드를 작성하고 있다고 생각하는 개발자는 누구든지 자신의 코드를 보고 쉽게 이해할 수 있다고 믿기 때문입니다. Resnick은 "개발자들에게 인센티브를 제공하여 문서화를 장려해야 한다"며 "문서화에 상당한 보너스를 지급하면 더 많은 문서를 얻을 수 있을 것"이라고 조언합니다.

결론

개발자들이 코드 문서화를 싫어하는 이유는 복합적입니다. 재미가 없고, 자기 보존 본능이 작용하며, IT 관리자들의 소홀함도 영향을 미칩니다. 젠AI가 부분적인 해결책이 될 수 있지만, 근본적인 해결책은 IT 관리자들이 문서화의 중요성을 인식하고 개발자들에게 인센티브를 제공하는 것입니다. 문서화에 대한 투자는 장기적으로 IT 운영의 효율성을 높이고 위험을 줄이는 데 도움이 될 것입니다.