On 02/02/2013 12:00 PM, Andrey Semashev wrote:
On Saturday 02 February 2013 11:46:19 Borislav Stanimirov wrote:
Hello,
I was wondering how one writes documentation.
I found QuickBook to be the easiest tool for documenting Boost libraries. You can find its docs on the site:
http://www.boost.org/doc/libs/release/doc/html/quickbook.html
The docs are written in QuickBook themselves so that's what your docs will look like in the end. On the front page you will find a link to quickbook.qbk which you can use as a starting point.
There are no requirements on the documentation structure, AFAIK. But generally it is a good idea to provide a tutorial, some expanded description and formal reference sections. Of course, it all depends on how large and complex the library is; sometimes it is enough to just have a tutorial if the library is small.
Many thanks :) This seems like a great tool