Re: [boost] Re: Re: Singleton Library Ready for Review

From: Jason Hise (chaos_at_[hidden])
Date: 2005-02-06 20:20:13

Jonathan Turkanis wrote:

>>Should I start working on the documentation then?  If so, what medium
>>should I use?
>>    
>>
>Definitely. In some respects the documentation is more important than the code.
>
>See http://www.boost.org/more/writingdoc/index.html. You should probably
>consider using Boost.Book: http://www.boost.org/doc/html/boostbook.html
>
>Make sure the docs are complete enough that people can easily evaluate the
>design of the library. But also remember that the design may change, so trying
>to perfect the documention too soon could end up wasting some time.
>
It looks like there would be a sharp learning curve involved in trying 
to use boostbook.  Although I think that such documentation would 
eventually be great, I think that it would take too much time to put 
together now while people are trying to evaluate my library.  Would a 
plain text tutorial be sufficient for the time being?

-Jason