[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [libreoffice-documentation] Suggestion


Maybe the Help content for functions could be used as a reference template with some automation to combine it with math background etc. to finally produce a separate handbook? Just thinking of how to avoid repetition of work and human errors.

Ilmari

Stephen Fanning kirjoitti 27.11.2019 klo 11.17:
I agree that it would be good to create a separate handbook to describe
Calc's functions and I will spend time creating a first draft of this
during the coming months.

As for the relevant chapter in the Calc Guide, I worry that it is now too
thick following the addition of so many new functions. My latest draft is
80+ pages. I suggest we retain it for the moment but I'll try too remove
excess verbage from descriptions that appear unnecessarily detailed. It
would be nice to shorten it a bit before issue!

I tend to agree with Jean and so when a separate handbook becomes
available, the chapter should be withdrawn from future issues of the Calc
Guide.

Regards,

Steve

On Wed, 27 Nov 2019 at 01:09, Jean Weber <jeanweber@gmail.com> wrote:

On Tue, 26 Nov 2019 at 18:13 Olivier Hallot <
olivier.hallot@libreoffice.org>
wrote:

Hi Steve

Em 26/11/2019 11:00, Stephen Fanning escreveu:
Olivier,

As you are aware I have noted some discrepancies between the Function
Wizard and the Help system with regards to the descriptions of the 500+
Calc functions. I have kept a list of the issues found so far and will
raise bugs in due course.

I am interested in these discrepancies because the Help system is
actually the reference information to users. Therefore, information
accuracy in the Help system is a quality issue and must be addressed.


[...]

Once I have completed the draft Calc Guide chapter, I would be prepared
to
carry out a more systematic and thorough cross-check of the function
descriptions over the next few months, as a background task. Would
that a
worthwhile exercise?

In the Calc Guide point of view, my personal opinion is that it can turn
the chapter into an extensive reference, which can turn the book a bit
too heavy, having pages and pages of esoteric
math/sciences/financial//computer sciences/.../ functions, perhaps
better fit into a "Handbook of LibreOffice Calc Functions" book on its
own.

Would that be a worthwhile exercise? yes definitely. Everyone will
benefit.

Help system: must be as accurate as possible with respect to the current
software implementation.

the "Handbook": will be a wonderful piece of work for LibreOffice Calc.
500 or more functions is not a small task, though.

Note: We often see a mix of objective in product documentation blurring
Reference info and Guide info. To try to make things a bit clear, the
software Help system must be reference-oriented, where information is
factual and accurate (and dull). For example, the Help system should not
be used to explain the math behind the COS function. The same COS
function can figure in a Guide with some trigonometry background info to
help user in achieving a goal, because Guides are essentially
goal-oriented information.

IMO the functions chapter should be a separate handbook, not part of the
Calc Guide itself. Years ago when the first iteration of the book was being
written, I argued against including it, but others wanted it in. To me the
Calc Guide (and all the guides) should be task- or goal-oriented (how to do
things), not reference books.

Jean




--
To unsubscribe e-mail to: documentation+unsubscribe@global.libreoffice.org
Problems?
https://www.libreoffice.org/get-help/mailing-lists/how-to-unsubscribe/
Posting guidelines + more: https://wiki.documentfoundation.org/Netiquette
List archive: https://listarchives.libreoffice.org/global/documentation/
Privacy Policy: https://www.documentfoundation.org/privacy



--
To unsubscribe e-mail to: documentation+unsubscribe@global.libreoffice.org
Problems? https://www.libreoffice.org/get-help/mailing-lists/how-to-unsubscribe/
Posting guidelines + more: https://wiki.documentfoundation.org/Netiquette
List archive: https://listarchives.libreoffice.org/global/documentation/
Privacy Policy: https://www.documentfoundation.org/privacy

Follow-Ups:
Re: [libreoffice-documentation] SuggestionRegina Henschel <rb.henschel@t-online.de>
References:
[libreoffice-documentation] SuggestionStephen Fanning <stevemfanning.wh@gmail.com>
Re: [libreoffice-documentation] SuggestionOlivier Hallot <olivier.hallot@libreoffice.org>
Re: [libreoffice-documentation] SuggestionJean Weber <jeanweber@gmail.com>
Re: [libreoffice-documentation] SuggestionStephen Fanning <stevemfanning.wh@gmail.com>
Privacy Policy | Impressum (Legal Info) | Copyright information: Unless otherwise specified, all text and images on this website are licensed under the Creative Commons Attribution-Share Alike 3.0 License. This does not include the source code of LibreOffice, which is licensed under the Mozilla Public License (MPLv2). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.