Re: [boost] Documentation for Boost libraries

From: David Abrahams (dave_at_[hidden])
Date: 2008-07-02 09:06:38

Bruno Lalande wrote:
> Hello,
> 
> As a Boost user, I find indeed very useful to have the same structure
> in almost every Boost docs, and I'm disturbed when it's not the case.
> The 2 most useful things in my opinion are a "quick start" or
> "overview" section at the very beginning as Edward said, and having in
> each page that presents a new class/function the precise header in
> which in can be found (very annoying when it's not indicated).
> Shouldn't Boost define a few elements like those ones that would have
> to be present in the documentation for a library to be accepted?

Yes, IMO we should have clearer standards for documentation.  There is a
whole mailing lists dedicated to Boost documentation issues; maybe you
should discuss the details there:
http://www.boost.org/community/groups.html#boostdocs

-- 
Dave Abrahams
BoostPro Computing
http://www.boostpro.com