Martina Waller wrote:
Hi all ,
in order to create a style guide for our help files I am currently
sifting through the existing help files. I have set up a wiki page
where I am collecting irregularities of the help style:
http://wiki.services.openoffice.org/wiki/Documentation/Help_Style_Guide
If you know of further inconsistencies, please add them to the wiki
page or let me know. Any comments are welcome, too.
Without my yet going through it, I might suggest (in the event it's not
covered) that a normal text paragraph be the first element (assuming
XML) after every subhead. Also, only use the next lower-level subhead
when there are at least two of such children subheads for each parent.
Otherwise, the exposition in the documentation should be rewritten in
order to comply. This "rule" is typically found in many corporate style
guides.
Another item: make sure that the documentation always agrees with the
GUI component name or text. Even if the GUI is in error, use the
erroneous GUI data in the documentation until the GUI component gets
rectified. There have been instances where there were as many as three
difference versions of GUI components in the past: one for the GUI
implementation, another for the online help, and yet another form in the
OOo documentation guide.
Gary
--
Gary Schnabl
2775 Honorah
Detroit MI 48209
(734) 245-3324
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
