개발을 하면서 문서화의 중요성에 대한 이야기를 많이 듣는다. 나 스스로도 문서화를 하면서 일을 진행하다보면 훨씬 정리되는 느낌을 갖는다.

그런데, 문서화라는 것에 어려움이 한가지 있다. 문서화라는 것은 여러명으로 이루어지는 개발팀의 뇌가 하나가 아니기 때문에 개발자들끼리 공통의 지식을 나누고, 좀 더 값싸게 소통을 해보려는 노력의 하나라고 생각한다. 그런데, 내가 좋아하는 문서포맷과 문서 스타일과 다른 사람이 좋아하는 문서포맷과 문서 스타일, 그리고 다른 사람2가 좋아하는 문서 포맷과 문서 스타일이 다르기 때문에 문제가 생긴다.

나는 위키를 설치해 놓고, 위키에 문서를 정리하기를 좋아한다. vim으로 하이라이팅된 소스들과 단계적인 레벨로 나뉘어 섹션별로, 그리고 문단별로 쓰여진 구조적인 문서를 좋아한다. 극단적으로는 dot 문법을 이용하여 모듈들간의 관계를 다이어그램으로 그려 놓는 변태적인 짓도 한다. (그림을 그리는 데에 드는 노력이 문법을 익히는 것까지 계산하여 꽤 많이 들어간다는 걸 생각하면 상당히 변태적인 짓이다.)

나는 열심히 위키에 혼자서 뻘짓거리 하면서 내용을 채워나갔다. 그런데, 아무도 호응해 주지 않았으며, 난 이렇게 좋은 공용 문서화 툴을 사람들이 왜 안쓰는지, 다른 사람들은 왜 문서화에 신경을 안 쓰는지 의아하게 생각했었다.

그런데, 다른 사람은 그들이 생각하는 최선의 것으로 나름대로 문서화를 하고 있었다. 우리 과장은 위키가 좋다고는 생각하지만, 파워포인트로 문서화 하기를 좋아한다. 문서가 장황하게 되는 걸 방지하고, 외부에 문서를 줄 때에도도 거부감이 없고 익숙한 범용적인 포맷이라 그런 것 같다. 그래서 파워포인트로 상당히 깔끔하게 문서를 만들어 낸다. 그러나 나는 파워포인트가 불편하다. 문서의 경직성이나 (셰어포인트를 쓰지 않는 이상) 공유가 번거롭다는 점을 들어서 난 "파워포인트"에 눈을 찌푸린다. 분명 우리 과장은 아마도 왜 저 친구는 내가 열심히 만들어 메일로 보내주는 문서들에 신경을 쓰지 않고, 또 왜 자신만 문서화에 신경을 쓰는지 의아하게 생각하고 있을 것이다.

개발자들 각자가 모두 다른 각자의 방법으로 열심히 문서화를 한다면, 참 안타까운 일일 것이다.

올블태그 : 개발 문서화 위키