On 7/19/07, Peter Foley <[EMAIL PROTECTED]> wrote: > All, > As Stjepan Rajko mentioned and John Maddock and Paul A Bristow > re-iterated I also think it would be useful to generate a standard > QuickBook document for Boost that provides the definitions and > conventions used throughout any documentation (kind of like what is used > within a hard copy text book to stipulate what different fonts, icons, > callout boxes mean) this can help cut away any confusion potential > readers or document writers would have. This could be stored centrally > and then included during generation of any documentation.
I think that we should include a link to a central place where this guidelines will live. It is not a good thing to have the same thing over and over in our html docs. An initial central place for documentation guidelines has been started here: http://svn.boost.org/trac/boost/wiki/DocumentationBestPractices But this place is more about guidelines for authors. You are looking for a place where docs user can learn how to interpret our docs. I think this deserve a separate quickbook based doc. Keep up the good work! Best regards Matias ------------------------------------------------------------------------- This SF.net email is sponsored by DB2 Express Download DB2 Express C - the FREE version of DB2 express and take control of your XML. No limits. Just data. Click to get it now. http://sourceforge.net/powerbar/db2/ _______________________________________________ Boost-docs mailing list [email protected] Unsubscribe and other administrative requests: https://lists.sourceforge.net/lists/listinfo/boost-docs
