Asciidoc is a great and lightweight markdown format optimal for writing documentation. We have adopted it already in some DKPro projects, abandoning DocBook XML. Compiling the asciidoc sources into HTML/PDF can easily be integrated with the Maven build process. Having the documentation as part of the source code instead of in the wiki facilitates having proper per-release documentation. Wiki documentation should be abandoned in favor of asciidoc.
reckart
commented
9 years ago
Asciidoc is a great and lightweight markdown format optimal for writing documentation. We have adopted it already in some DKPro projects, abandoning DocBook XML. Compiling the asciidoc sources into HTML/PDF can easily be integrated with the Maven build process. Having the documentation as part of the source code instead of in the wiki facilitates having proper per-release documentation. Wiki documentation should be abandoned in favor of asciidoc.