Subject: Re: [boost] Best boost documentation
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2015-01-23 05:05:55
> -----Original Message-----
> From: Boost [mailto:boost-bounces_at_[hidden]] On Behalf Of Damian Vicino
> Sent: 23 January 2015 08:48
> To: boost_at_[hidden]
> Subject: [boost] Best boost documentation
> Iâm preparing a library to be proposed and Iâm adapting the documentation I had to
> be more Boost-like.
> I saw there is different writing styles in the documentation.
> Something Iâm specially interested is in the document structure, I saw some start
> with a tutorial, others with an overview of the concepts, others just go straight to
> the internals.
> Iâm wondering if there is a preferred style or document structure to use.
There are no fixed rules, but I think that a tutorial-ish "Why use this library? What it does for you."
is the best way to start.
Providing links to external documents, other Boost libraries and to internal details is important to the user.
The best tool, again in my opinion, is the Quickbook, Doxygen and Autoindex toolchain.
You will find a number of more recent libraries use this. It provides a Boost-ish 'look'n'feel.
If you would like help to prototype your proposed library documentation, contact me off list.
--- Paul A. Bristow Prizet Farmhouse Kendal UK LA8 8AB +44 (0) 1539 561830
Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk