Re: [boost] Copy editing documentation - SOC project

From: Joel de Guzman (joel_at_[hidden])
Date: 2007-03-12 09:42:25

Nava Whiteford wrote:
> Matthias Schabel <boost_at_[hidden]> wrote:
> 
>>> FYI, QuickBook already has the reverse-lit feature. It lets you
>>> "import" code snippets from actual code. Rene and I are using it
>>> right now to great effect.
>> I have to say, as a non-CS person, I'm finding it hard to even keep
>> track of the differences between DocBook, BoostBook, and QuickBook,
>> much less figure out how to accomplish anything with them... Just as
>> a side note, given that documentation is already generally regarded as
>> one of the most painful parts of library development, I think it  
>> would be
>> a good idea for Boost to standardize on one system or another and
>> then provide a good tutorial on how to use it... For example, after
>> browsing all the QuickBook documentation I could find, I still have
>> no idea how to implement the code snippet import feature you
>> described; 
> 
> After working with Gennadiy to copy edit some documentation I'd have to 
> agree. Everyone has there own preference, Word, Docbook, Latex etc. but 
> you need some common standard if your going to working collaboratively on 
> documentation, ideally it should be a format the preserves markup in some 
> explicit way.

I'm confused. What are you agreeing on? Are you using BoostBook/
QuickBook? Matthias post is about QuickBook.

Regards,
-- 
Joel de Guzman
http://www.boost-consulting.com
http://spirit.sf.net