1. 머리글

1.1. ROBODoc 소개

ROBODoc은 다양한 언어에서 사용할 수 있는 Documentation Tool이다. http://sourceforge.net/projects/robodoc에서 프로젝트가 진행중이며 이곳에서 소스를 받을 수 있다. 프로젝트의 홈페이지는 http://www.xs4all.nl/~rfsber/Robo 이다.글을 쓰고 있는 현재 버전은 4.0.0이다.

ROBODoc은 매우 많은 언어를 지원한다. ROBODoc은 고유한 주석형태를 가지고 있기 때문에 사용하는 언어가 무엇인가에 크게 영향받지 않는다. ROBODoc이 지원한다고 메뉴얼에서 밝힌 언어는 다음과 같다.

C, C++, Java, Assembler, Basic, Fortran, LaTeX, Postscript, Tcl/Tk, LISP, Forth, Perl, Shell Scripts, Occam, COBOL, HTML와 기타 언어들.

ROBODoc은 문서화 작업을 위해 소스내의 주석을 사용하기 때문에 개발과 문서화 작업을 통합할 수 있고 문서의 업데이트를 용이하게 할 수 있다. 뿐만 아니라 HTML,LaTex,XML DocBook 을 비롯한 다양한 형식의 출력포맷을 지원하고 다중 파일형식으로 출력할 것인지 단일 파일로 출력할 것인지 등을 지정할 수 있게 한다.

ROBODoc은 설치와 사용법이 매우 간단하다. 배포되는 소스코드는 ROBODoc을 사용하여 주석처리 되어 있으며, 사용자들이 간단히 copy & paste로 사용할 수 있는 유용한 template도 함께 제공한다. 주석처리 문법은 계층구조를 지원하며 아주 직관적으로 구성되어 있어, 처음보는 사람도 쉽게 익힐 수 있게 되어 있다.

이 문서에서는 다양한 언어와 출력포맷의 지원, 손쉬운 설치와 사용방법, 개발작업과 문서작업의 통합과 같은 특징을 지닌 ROBODoc을 이용해 문서화작업을 진행하는 방법을 살펴본다.

1.2. 저작권 정보

이 문서는 GNU Free Documentation License 버전 1.1 혹은 자유 소프트웨어 재단에서 발행한 이후 판의 규정에 따르며 저작권에 대한 본 사항이 명시되는 한 어떠한 정보 매체에 의한 본문의 전재나 발췌도 무상으로 허용됩니다.

1.3. 책임의 한계

본 저자는 문서의 내용이 야기할 수 있는 어떠한 결과에 대해서도 책임을 지지 않습니다. 본 문서에서 내포하고 있는 정보들 및 예제들은 여러분이 알아서 활용하십시오. 비록 최선을 다했으나 이 문서는 틀린 점이나 오류가 있을 수도 있습니다. 만약 여러분이 틀린 점을 발견했다면 꼭 저에게 알려 주시기 바랍니다.

1.4. 피드백

이 문서에 대한 발전적인 제안이나 수정사항, 문제점 등에 대한 피드백은 언제든지 환영합니다. 로 메일을 보내 주십시오.