읽을거리) 개발자가 코드 문서화를 꺼리는 진짜 이유

개발자가 코드 문서화를 꺼리는 진짜 이유

 

원본 링크 : [링크]

개발자가 코드 문서화를 꺼리는 진짜 이유

 

 

<간단 요약>

문서화를 하지 않는 이유와 해결 방안에 대한 간략한 설명과 함께

개발자의 심리를 설명하는 문서이다.

 

 

반응형

 

<문서화를 회피하는 개발자의 심리 >

 문서화는 재미와는 정반대이다.

문서화가 부족하면 여전히 자신이 필요하다는 인상을 주고, 반대로 문서화를 많이하면 자신의 가치가 떨어진다고 생각한다.

 

반응형

 

< 문서화를 방치해온 관리자들의 책임 >

개발과정에서 문서화는 필수이지만 관리자는 당장 눈앞에 있는 문제를 해결하기 위해서 문서에 대한 시간을 할애하지 않는다.

이런 상황이 반복되면 레거시 코드에 문서가 없는 상태가 발생하기도 한다.

 

< 생성형  AI 도입과 문서화의 관계 >

AI를 활용함으로 문서화의 부담을 줄여줄수 있지만, 개발자읜 근본적인 동기 까지 바꾸기는 어렵다.

 

< 문서화 공백의 유형과 관리 전략 >

IT 관리자 및 기업은 사실상 3가지 유형의 문서화를 고려해야 한다.

	코드 종류	상황
1	오래된 코드	원 개발자는 이미 퇴사함
2	최신 코드	원 개발자는 회사에 여전히 있음
3	현재 개발 중인 코드

이러한 문제를 단일하게 접근하기 보다는 각각의 상황에 맞는 대처 및 문서화 전략이 필요하다.

< 해결방안 : 인센티브와 문화 변화 >

IDC의 아담 레즈닉 연구 매니저는 "문서화 부족은 현대화를 어렵게하고, 신규 인력의 온보딩,보안,감사,버그 수정,유지보수 등을 복잡하게 만든다"고 강조한다.

기업 문화나 보상 체계에서 문서화에 대한 구체적인 인센티브를 지급하거나 

문서화하는 과정을 성과로 포함을 하는 등 적극적인 문서화에 동기를 부여해야 한다.