Re: [libreoffice-l10n] Need for a solid help content

Hi All,

+1 on what Michael said about help.  I know that traditionally we've had
inbuilt help for a long time, and I know that some feel like it's really
important, but in my opinion, it's more of an emotional factor and
tradition than real need. I especially don't think that maintaining two
sets of help content (one for wiki, one for inbuilt files) independently
makes any sense, and I surely hope we don't do that. If some of us do
that, well, no offence, but in my opinion they're wasting their time. If
"offline help" is so crucial, can't we provide means to download or wiki
as a generated help file, or as a VM instead?

By the way, Oliver, I don't understand why a particular *type* of help
should be mentioned in an SLA at all. Do they charge differently for
questions covered in built-in help, or what? Would anything in the SLA's
have to change drastically if instead of opening the help file F1 would
open a wiki page in a browser?

Rimas

2015-12-13 21:26, Michael Bauer wrote:
> Olivier,
>
> What you wrote makes sense but seems to talk more about the online
> help rather than the inbuilt help. I can think of several commercial
> and OS tools off the top of my head which do not carry inbuilt help
> these days. Going to Help in Trados for example these days redirects
> you to the online Help whereas in the old days, there used to be
> inbuilt Help. Adobe also redirects to F1 user to online Help. MS
> Office only has vestiges of Help left ("Basic Help" in Word for
> example about using the Ribbon). Anything else you need to hit the
> Microsoft website for.
>
> It may be that inbuilt Help was once the norm but I do not think it's
> going to be the norm for much longer and for obvious reasons
> (maintaining it seems to be a bit of a nightmare, in contrast to
> things like wikis).
>
> Don't get me wrong, I'm not suggesting that we need no form of
> documentation. It's just the inbuilt stuff which I personally feel is
> becoming more of a liability than a useful tool in LO. Perhaps
> other/most users *like* inbuilt Help, I don't know, I do not consider
> myself the arbiter of such things, which is why I said it would be
> nice if some research was done. But I get the feeling Help is shifting
> onto the web more and more and if that is the case and if there are
> good reasons, LO should contemplate this.
>
> Michael
>
> Sgrìobh Olivier Hallot na leanas 13/12/2015 aig 19:05:
> > There is a dimension where documentation get critical, and this is in
> > the enterprise and in the development. A software that does not carry
> > proper documentation is subject to several drawbacks. First, the help
> > desk of the enterprise need to get trained into the issues of
> > LibreOffice in the same way they need to addres MSOffice issues. For
> > that they need to know how the software works to assist the users.
> > Docs and references are crucial, together with proper professional
> > support. Second, the help desk is often charged per call. Enterprises
> > where user cannot find proper doc in their own language is facing a
> > higher TCO, because users call HD to get what they don't have at
> > hand. Third, in the way open source is developed and LibreOffice in
> > particular, there are no specs written in the canonical form a priori
> > before implementation (as it was in the OpenOffice.org times under
> > SUN/Oracle) and this is a choice LibreOffice made to offload all
> > hassle of development and rush into coding improvements long due. The
> > trade-off is a bunch of nice features very few know how to work and
> > the curious take much long time to figure it. Forth, by writing the
> > help pages we have a minimum of a reference guide to address bugs and
> > regressions. Without a reference, a regression is allway harder to
> > understand for the developer and the QA guys. Think about shortcut
> > ABC, that suddenty does not work anymore... how can the developer be
> > sure the sortcut was inded supposed to do what ABC was designed
> > originally.... So, users may not like the help content as we have
> > today and don't like to press F1, but it is our pursuit of quality
> > software to give them the best we can do in terms of documentation.
> > Admitedly our help system is not a piece of literature easy to read
> > (nor is MS Office too), but it must fullfill the mission to establish
> > the landmark of the sofware behaviour. Yes, "RTFM" comes to my mind
> > actually, but there must be an M somewhere. Finaly, other
> > documentation tools like public forums, books, wikis and even Google
> > are all stars of a documentation constellation but almost never
> > figure in a help desk SLA. As more litterature we produce on
> > LibreOffice, the best, because one of the steepest entry barrier we
> > have to propagate LibreOffice is its lack of culture in the office
> > suite marketplace, something MS already achieved long ago and is
> > extremely hard to displace. Of course, there is room for improvement.
> > The nice part of this is that it is well suited for the
> > non-code-developer community of LibreOffice. Give Help a chance. Kind
> > regards 



-- 
To unsubscribe e-mail to: l10n+unsubscribe@global.libreoffice.org
Problems? http://www.libreoffice.org/get-help/mailing-lists/how-to-unsubscribe/
Posting guidelines + more: http://wiki.documentfoundation.org/Netiquette
List archive: http://listarchives.libreoffice.org/global/l10n/
All messages sent to this list will be publicly archived and cannot be deleted