2005년 10월 29일에 네이버 블로그에 적은 글입니다.


문서의 피드백

문서화 작업의 가장 문제점 중 하나가 피드백이라고 생각합니다. 문서화 라는게 자신이 보는 것도 중요하지만 더 중요한 것은 남이 본다는 것인데 그렇다 보니 만들면서 언제나 이게 잘하고 있는 것인가에 대해 의문의 느끼게 되더군요. 수학문제 처럼 어떻게 답이 나오는 것이 아니니 참 애매 합니다. 그렇다고 주위에서 평가를 해주는 것도 아니고저의 경우도 1차적으로는 제가 주위 개발자에게 열심히 보여주면서 평가를 받아야 되는데 저 자신이 자신이 없다보니 자신 있게 피드백 해주기를 요구 하지 못하고 또 다른 개발자 분들은 자신이 할 일이 있다 보니 남의 것을 평가해 줄 시간도 없고, 또 평가 할 때 잘못하면 사이가 어색해 질 수가 있다고 생각하고 있지 않나 생각합니다.

좋은 개발 문서를 만들기 위해서는 피드백이 상당히 중요한데 현재 상황에서는 피드백 받기가 쉽지 않아서 한동안은 삽질을 하지 않을까 생각도 합니다.

 

꾸준한 문서 작업 방식 개량
일반 개발 프로세스 관련 책에 나오는 문서화 방식은 일반적인 기준이라서 개개인의 성향이나 개발자가 속한 환경에 따라서 그에 맞게 적용해야 된다고 생각합니다. 그래서 자신과 환경에 맞는 문서 작업 방식을 찾고 알맞도록 꾸준히 개량해야 된다고 생각합니다.

 

저도 위에 적었듯이 지금 하는 문서 작업 방식은 이제 3개월이 되어갑니다. 그래서 아직 고칠 점이 많이 있을 거라고 생각합니다. 문제점이 드러날 때 마다 강구책을 세워서 적용해보고 가능한 문서화 작업 방식이나 방법에 대해서 많은 개발자와 상의를 할 수 있다면 아주 좋은 결과가 나오지 않을까 생각합니다.

 

 

저는 아직 프로그래밍도 미숙하고, 문서화에도 미숙한 편입니다. 그래서 이런 이야기를 다른 개발자 분들과 여러 가지 이야기를 나누어 봤으면 합니다. 보통 저 말고도 다른 개발자분들도 기회가 되면 다른 개발자분들과 대화를 나누면서 교류를 하기를 원하는데 그럴 방법이 없었어 아쉬워 하더군요개발자들끼리 정기적으로 오프라인에서 모일 수 있는 모임이 있으면 참 좋을 거라고 생각합니다.

 

제가 글 적는게 약해서 헷갈리게 글을 적지 않았나 생각되고 또 별 도움 안되는 이야기를 적었는지 모르겠습니다.. 이런 이야기를 직접 만나서 하면 좀 쉬울 텐데 이렇게 글로 적어서 표현 할려니 쉽지 않네요많이 부족하지만 이후 저의 문서화 작업 방식에 또 다른 변화가 생기던가 문제점을 발견하면 또 글을 올리겠습니다.^^


* 참고로 2008년 현재 이때 적은 글과 방식이 변경된 부분이 있습니다.
관련해서 글을 올리겠습니다.

신고
by 흥배 2008.03.20 23:20