본문 바로가기
잡담/긁적

프로젝트 문서에 대한 단편적인 생각들

by 키운씨 2010. 3. 17.

문서가 있다는 것만으로는 도움이 안된다

어차피 정리 안된 수십 기가의 자료를 복사해 주며 인수인계니까 참고하라고 던져주는건 알아서 정리하세요... 와 같다


정말 그럴듯한 문서가 필요하다면 나보다 못한 실력을 가진 사람이 봐서도 이해하기 쉽게 적혀있어야 한다

예를 들어, UML을 볼 줄 모르는 사람한테는 아주 간단한 UML조차 전혀 도움이 안된다

그럴땐 옆에서 간단하게 전체 그림을 그려가며 친절히 설명해주는 것이 정답이다

 

뛰어난 실력자가 내가 만든 문서를 본다한들 그 사람은 내 프로그램을 유지보수 할 생각은 없다

다만 아키텍처를 보고 새로운 설계를 하고 싶을 뿐이다

역시 그때도 복잡한 UML은 필요없다

그냥 칠판에 전체 구성과 프로세스를 대충 설명하는 것만으로도 충분하다

 

결론은 일일이 그림 그려가며 설명할때를 위해 문서를 작성해야 한다

그것이 바로 나를 위한 일일 테니까

'잡담 > 긁적' 카테고리의 다른 글

개발자의 로망  (0) 2010.04.06
인생에서의 효율성  (0) 2010.03.21
내공 6갑자  (0) 2010.01.22
전통  (0) 2010.01.16
개목걸이  (0) 2009.08.02