지속적인 사용자 매뉴얼 생성

Question

"연속 문서"를위한 솔루션이 이미 있습니다. Jenkins/Hudson 용 문서 작성 마크 업 언어 및 플러그인 작성

API 설명을 생성하는 것이 아니라 스크린 샷이있는 사용자 매뉴얼에 관한 것입니다. 사용자 매뉴얼을 최신 상태로 유지하는 것은 항상 지루한 일이므로 생각해보십시오. 일부 마크 업 (xml)에서 사용자 매뉴얼을 읽은 다음 빌드 프로세스 중에 html 및 pdf로 변환해야합니다.

이것은 구현하기에 매우 간단하지만 이미 솔루션이나 모범 사례가 존재하는지 궁금합니다. Sphinx과 비슷하지만 Javas에서는 파이썬을 사용할 수 없기 때문에 가능합니다.

Answer 1

불행하게도 순수 자바 세계의 많은 선택이되지 않습니다

당신이 Markdown를 사용할 수있는 간단한 매뉴얼에 대한
• 및 f.ex. 같은 자바 구현 PegDown; 이 기능은 간단한 HTML 매뉴얼에는 유용하지만 PDF 생성은 종종 어렵습니다.
• 이미 스핑크스 - 문서가있는 경우에는 restructuredText-Java 구현을 사용할 수 JRst (안 스핑크스와 같은 강력한) 또는에는 JPython와 스핑크스를 실행 ...
내 의견 솔루션이를 작성하는 것입니다 최고 문서는 AsciiDoc입니다. Ruby 포트는 AsciiDoctor으로 몇 주 후에 (JRuby를 사용하는) a Java-Wrapper이 존재합니다.

AsciiDoc 언어는 매우 강력하며 AsciiDoc에서 DocBook을 쉽게 만들 수 있습니다. DocBook의 경우 많은 경우 (때로는 숨겨진 ...) Java-Tools가 존재합니다.