Re: Documentation

As far as writing documentation is concerned I found the the "standard" boost position at: C:\boost_1_31_0\more\writingdoc\index.html To be very helpful. I think it goes a long way to providing a common look and feel the boost docs. By providing a skeleton document for a boost library it also saves a lot of work. I tried to follow it as closely as possible for the boost serialization library. I think the discussions around boost documentation should focus on how this "document" document (meta-document?) should be updated. So it might a) Be a little more specific re tutorial and reference documentation sections. This is not quite as easy as one would first think as the requirements for formatting/tables of overloads are different from from function calls, etc. b) Suggest a common navigation facility. I actually liked the navigation pane used by the BOOST_PP library and have incorporated something similar in the new serialization library documentation. I find it very helpful. Robert Ramey
participants (2)
-
John Nagle
-
Robert Ramey