Hi Regina,
Regina Henschel wrote:
Hi Martina,
Martina Waller schrieb:
Hi all,
as you may know we have various inconsistencies in the Calc functions
help (see also issue 54559). In order to eliminate these I am
proposing a new help style guide for the Calc functions on
http://wiki.services.openoffice.org/wiki/Documentation/Dashboard/Help_Style_Guide.
If you have any ideas for improvement, please let me know.
Arguments are separated by semicolon not by colon. Please look where
to change it in addition to the place I have changed. I don't know why
you mention "colon" in the other places.
My first approach was to look into the inconsistencies of the current
help style. "colon" is mentioned in the other places because currently
we have several cases where the "Syntax" and "Example" headings as well
as the arguments are followed by a colon. That should change for reasons
of consistency.
Additional comments:
(1) If you give examples do not silently assume, that the local is
en-US, but give additional versions/informations.
=DATE(00;1;1) yields 1/1/00, if the cell format setting is "MM/DD/YY"
(2) Give examples that are unambiguous.
=DATE(2000;1;31)
(3) Never use quotes if they are not used literal. You confuse the
user whether to use a string or a number. For example =DATE("00;1;1")
has wrong syntax.
(4) Tell the user whether an argument type is silently converted or not.
(5) Tell the user which general settings influence the function
result. Here the general setting how two-character years are expanded
to four characters.
(6) Tell the user, for which incorrect arguments no error is
generated. Here for example, if the year is a string.
(7) Tell the user, if named ranges, named formulas, labels or named
data ranges are not resolved to their content or are forbidden.
(8) Tell the user, if a function works different from the
corresponding one in Excel.
(9) Tell the user the mathematical formula, which is used to calculate
the result, like Microsoft does it, see for example
http://office.microsoft.com/en-us/excel/HP052092101033.aspx
(10) Tell the user if internal underflow or overflow is not
automatically detected. Tell about the accuracy if possible.
These are all good points although most of them are more related to the
contents than to the style of the help. I will try to include your
comments into the help style guide as far as it is possible.
Thanks for your comments
Martina
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
--
[EMAIL PROTECTED] - Technical Writer
StarOffice - Sun Microsystems, Inc. - Hamburg, Germany
http://www.sun.com/staroffice
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
