Boost logo

Boost :

Subject: [boost] Best boost documentation
From: Damian Vicino (damian.vicino_at_[hidden])
Date: 2015-01-23 03:47:59


Hi,
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.

Best regards,
Damian


Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk