Boost logo

Boost :

Subject: [boost] Indexing of documentation (Was: Why Boost.Build?)
From: Vladimir Prus (vladimir_at_[hidden])
Date: 2011-03-27 15:39:50


Edward Diener wrote:

> The documentation is generally poor because it does not attempt to
> explain all of the information in Boost Build, and what it does explain
> is spread out in many different areas of the documentation to the
> detriment of the documentation's organization. Finally, what passes for
> an index in the documentation indexes practically nothing and is
> essentially completely worthless.

I think it would be great if somebody who knows how to write documentation
could write some guidelines how to produce usable index. Every time I
think about adding anything, I am not even sure what should be primary
index term, and what should be secondary ;-)

- Volodya

-- 
Vladimir Prus
Mentor Graphics
+7 (812) 677-68-40

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