2012/9/20 RGB ES <rgb.m...@gmail.com> > 2012/9/16 Keith N. McKenna <keith.mcke...@comcast.net> > >> Greetings All; >> >> >> In order to stimulate some discussion on user documentation I have added >> the hollowing page to the User Documentation Plan on the Plannig Wiki: >> https://cwiki.apache.org/confluence/display/OOOUSERS/User+Guides+Revisted. >> It offers 3 scenarios or the creation of the docs. I believe that we can no >> longer put this issue aside. >> > > I added a child page were I think aloud about scenario 3 and start the > discussion about how to organize the documentation if we decide to build > our own > > https://cwiki.apache.org/confluence/display/OOOUSERS/Details+on+Scenario+3 > > Regards > Ricardo >
Since some weeks there is an ongoing effort on the ES wiki to organize the basic documentation for AOO.(1) I experimented with the distribution of different arguments and arrived to a configuration that I find interesting. This distribution is different from usual user documentation in the sense that it is highly cross referenced: The first chapter try to give a general description of AOO as a whole, without entering on the details of each specific app while the following chapters reference to the first one as much as possible. After that, each chapter clearly separate direct formatting from styles but trying to not explain same things twice: configuring a numbered list indent is the same when doing direct formatting or modifying a list style, so... more cross referencing. Based on this (not completed yet) experience I added a "proposed TOC" to the "Details on Scenario 3" page. Only chapters 1 and 2 are really detailed, but the idea is to give to the Calc, Impress and Draw chapters a structure similar to the one used on Writer's chapter. Regards Ricardo (1) http://wiki.openoffice.org/wiki/ES/Manuales/GuiaAOO
