프로젝 디자인과 문서화를 어떻게 하시나요?

litdream의 이미지
litdream의 이미지

프로젝을 디자인 할때부터, 문서화의 딜레마는 시작됩니다.
이후, 프로젝이 진행되면서 팀원들과 의사소통을 하고난후,
문서로 남기지 않으면 훗날 크게 괴롭게 되지만, 일단 이부분은
제껴두고, 공식적으로 큰 문서들을 어떻게 하는지 궁금해서 여쭙습니다.

저는, 일단 저의 파트를 시작할때, 종이와 연필을 사용해서
상당한 다이어그램을 그리면서 시작됩니다.
그런후, README 와 history 화일을 만듭니다.
README 는 그때 그때 필요한 지식들을 때려넣고,
history 는 버젼이 바뀔때, 바뀐 내용들을 간략히 넣어서, 훗날
CVS tag으로 사용합니다.

나름대로 체계가 있는것 같지만, 종이와 연필을 사용한것은 다른사람에게
보여줄때 원본을 보여주던지, 아니면 복사기 앞에서 시간을 보내야하는
허무함이 뒤따르고, text file 을 사용하면 그림그리기가 보통 괴롭지 않습니다.
예전에 어느분이 Wiki 로 documentation 을 한다는 혁신적인 아이디어를
낸 기억이 나서, 어떤것이 젤 좋을지 한번 여쭤봅니다.

삽질의 대마왕...

hurryon의 이미지

일단 종이와 연필로 스크래치를 먼저 한 후에...문서화를 하는게 보통 아닌가요? 물론 문서화를 할때는 웹보드 기반 보다는 오피스류나 UML 툴을 이용하는거 같습니다.