With respect, I have to disagree with some recent comments on this list. Tools like Git and slack channels have an important role in managing generations of software. But they don't, and largely can't, focus on what's most central to good documentation.
Like all written, and even spoken, language, documentation must be readily understandable. It must flow easily. It cannot get struck in a corner. At its best it might, by being enjoyable, be even more effective than anticipated. By virtue of my experience in higher education, I'm certain that most AOO users resemble my former students. Few of them have been tasked with installing or configuring anything, and so have little interest in, or even recognition of, tools like Git or slack channels. Points on being scrupulous about formatting are of course important. But I think what's even more salient to successful documentation is wording that's both correct and friendly. For instance, this entry from Calc Chap. 2 (Entering, Editing, and Formatting Data) is an excellent example not only of how to write a good error message, but also of how to write useful documentation: (Edits and ellipsis mine.) To be of real help to users, particularly inexperienced ones, [error] messages need to provide details [ ... not only on what went wrong but also on how to correct it. ] On Thu, Sep 12, 2024 at 3:41 AM Dick Groskamp <th.grosk...@quicknet.nl.invalid> wrote: > Thanks Keith ! > > Greetings > > Op 11-9-2024 om 21:57 schreef Keith N. McKenna: > > These have know been corrected. I had noticed the getting started guide > was > > there the other day and removed it and restarted it as AOO41WG.odt. I > renamed > > the made the corrections to the odt fie and deleted the pdf file as it > will > > have to be recreated from the corrected odt. > > > > > > On 2024-09-11 at 08:14, "Dick Groskamp"<th.grosk...@quicknet.nl.INVALID> > > wrote: > >> I just had a look at AOO41WG1-IntroducingWriter.odt > >> > >> I noticed two small inconsistencies on page 2 as to AOO41GS: > >> > >> 1: *(where xxx is the command to undo) *- I think this should not be > bold > >> > >> 2: *Tools contains* functions - I firmly believe that "contains" should > >> not be bold > >> > >> Should we change it ?? > >> > >> > >> Also noticed that in the directory ForWiki the file is called > >> AOO41WG1-IntroducingWrite.odt - without the "r" behind Write > >> > >> The file has also Record changes enabled, which reflects in the pdf of > >> that file :-) > >> > >> -- > >> DiGro > >> ___________________________ > >> Apache OpenOffice 4.1.15 (Dutch) and scanned with Ziggo Safe Online > > (F-Secure) > > > > > > --------------------------------------------------------------------- > > To unsubscribe, e-mail:doc-unsubscr...@openoffice.apache.org > > For additional commands, e-mail:doc-h...@openoffice.apache.org > > > -- > DiGro > ___________________________ > Apache OpenOffice 4.1.15 (Dutch) and scanned with Ziggo Safe Online > (F-Secure) >
