반응형

문서 자동화

소스코드 문서화를 위한 툴로 Doxygen이 있다는 것은 알고 있었고,

사용해 보면서 무척 편리하다고 느꼈었다.

하지만 실제로 필요한 문서들은 소스코드 문서에 그치지 않고

UML Diagram, DB ERD, 사용자 문서 등이 모두 필요하다.


문서화 관련해서 검색하던 중에,

다음과 같은 문서 자동화를 모두 망라해서 설명한 사이트를 발견하게 되었다.

  • UML Diagram
  • DB ERD
  • 소스코드 문서화
  • 사용자 문서

블로그로부터 문서별 툴을 정리해 보면, 다음과 같다.

문서 종류 

 툴

 UML Diagram

 UMLGraph

 DB ERD

 스키마스파이(SchemaSpy)

 빌드 다이어그램

 그랜드(Grand)

 소스코드 문서

 Doxygen

 사용자 문서

 DocBook


이런 툴을 이용할 때의 장점은, 이미 완성된 소스나 DB 스키마를 가지고

문서를 작성해 준다는 것이다.

문서를 먼저 만들고 개발을 하는 것이 전통적인 개발의 정석이지만,

현실적으로 뒤늦게 문서를 만들어야 하는 경우도 비일비재하다.

또한, 최근의 개발론은 꼭 전통적인 방식을 따르지 않는다.

여하튼, 여러가지 이유로 구현된 결과물을 가지고 문서 작업을 하게 될 때

위 방법들을 알아두면 많은 도움이 될 것이다.

반응형

+ Recent posts