Documentation

Posts Tagged ‘Documentation’

Documenting Open Source Software

Someone asked what we use to produce the documentation for VoltDB. The simple answer is DocBook.

DocBook is an XML schema for structured documentation. Originally designed for UNIX-based hardware and software documentation, DocBook is generalized enough for most technical documentation purposes. The advantages to DocBook are that it is a standard, well-documented format (Docbook is part of the OASIS standards) and there are processors for both hardcopy and online output, as well as translators to other formats.

But DocBook is only a format; it isn’t a set of tools. So the more complicated answer to the original question is that … Read more