프로그램 소스코드 인수인계를 위한 다큐먼트라면?

godway의 이미지

회사에서 열씨미 프로그래밍을 하고 있었습니다
그런데 어느날 인수인계를 위해서 다큐먼트를 만들라고 하였습니다

여기서 다큐먼트란 다음 사람에게 소스코드를 넘김에 있어서
도움을 주기 위한 다큐먼트라고 생각되어 집니다

그럼 다큐먼트에는 어떤 내용들이 들어가야 할까요?
- 프로그램 구조
- 사용되는 스트럭처
- ...........

어떻게 그리고 어떤 내용의 다큐먼트를 만들어야 인수인계 받을 프로그래머가
그 프로그램을 이해하기 쉽게 되는 걸까요?

이를 위한 의견을 묻고 싶습니다
그리고 혹시 이러한 일들을 해주는 툴이 있나요?
(제가 워낙 게을러서요 :) )

불량청년의 이미지

프로젝트 진행하면서 문서화를 안하셨나보군요.

인수인계 때 프로젝트 진행중 산출된 문서만 준다면

별 문제 없겠지만, 회사 사정이나 기타 프로젝트

팀원들의 문서화에 대한 생각에 따라서 달라지겠죠.

H/W가 컴퓨터의 심장이라면 S/W는 컴퓨터의 영혼이다!

saxboy의 이미지

궁극의 툴 doxygen~

godway의 이미지

saxboy wrote:
궁극의 툴 doxygen~

감사합니다.
지금 다운받아서 설치하고
메뉴얼 보면서 이것저것 해보고 있습니다. :D 8)

============================
=== God is love ===
============================