Re: [boost] Indexing of documentation (Was: Why Boost.Build?)

Subject: Re: [boost] Indexing of documentation (Was: Why Boost.Build?)
From: Rene Rivera (grafikrobot_at_[hidden])
Date: 2011-03-30 17:55:09

On 3/27/2011 3:02 PM, Artyom wrote:
>> 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
>>
>
>
> Volodya,
>
> I think you should write the documentation as you write it for any
> software or library.

Thanks for the suggestion.. <https://svn.boost.org/trac/boost/ticket/5391>.

-- 
-- Grafik - Don't Assume Anything
-- Redshift Software, Inc. - http://redshift-software.com
-- rrivera/acm.org (msn) - grafik/redshift-software.com
-- 102708583/icq - grafikrobot/aim,yahoo,skype,efnet,gmail