-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

- -------- Original Message --------
From: jonathon <[EMAIL PROTECTED]>
Date: Mon 29 Oct 2007 02:53:43 EST

> Dave wrote:
> 
>> Sophisticated computer software is a technical subject and it's 
>> documentation cannot be reduced to "non-techie" kindergarten level.
>> 
> 
> The goal that is aimed at, is that somebody who is computer
> illiterate can pick up the documentation, and do anything that the
> software was designed to use.

I would agree that should be the goal, but it is impossible to write one
single document which will meet the needs of all user competence levels.
If it were possible, then someone with no knowledge of First Aid should
be able to perform complex neurosurgery just by reading the relevant
chapter of "Brain Surgery for Dummies" :)

>> does not mean that the documentation is badly written
> 
> Since the aim of the project is to provide usable documentation, if a
>  novice does not understand it, it is badly written.

No it does not automatically become a fact that all the documentation is
badly written, just because ONE novice fails to understand one small
portion of the documentation. I have taught several introductory OOo
classes to complete computer novices and have rarely found any of these
novices unable to comprehend the OOo documentation. Obviously, there is
little point in expecting someone to understand the documentation on
macro writing, no matter how simplistically that documentation is
written, if they do not even understand how to open the Writer program.

I am not claiming that all OOo documentation is perfect. There are
undoubtedly parts that would benefit from some revision and should
always be under review. However, in comparison to the documentation
provided by some major commercial software companies, I think the work
of the folks on the documentation project is to be commended.

> (Incidentally, this is the reason why programmers should never write
> documentation.)

Incidentally, I am a programmer and I do write the documentation for my
commercial software, most of which is produced for specialized
industrial systems. I rarely receive any negative feedback about the
documentation from intelligent customers.

However, in principal I would agree that for mainstream general
applications, such as OOo, documentation should be developed by people
other than the software programmers. My understanding is that
documentation and development are separate arms of the OOo project.

BTW In spite of my specific request to the contrary, the OP replied to
me directly off-list. I am only quoting part of their very long
communication because they did not realize their original posting was
going to a public mailing list and might not wish to have the entire
contents aired publicly.

The OP conceded that they were trying to use some of the program's more
advanced functions before learning the basics of word processing and had
made no effort to locate any beginners guides (eg. "Getting Started Guide")
The OP concluded with the following:
<Q>
You most certainly can reduce the instructions down to a "non techie"
Kindergarten level.  You did an excellent job of that right here!  And
thank you very much!
</Q>
The OP was right only in respect to the fact my answer was targeted at a
specific level of user competence, about a defined user requirement.

Jonathon, If we choose to discuss this further, I think maybe we should
take it over to the discuss list.

Cheers

Dave
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.7 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iD8DBQFHJSNP7asJm/pW/p8RAitzAKCjMkcLCC71aZJg/SAI0hqbQrKmdwCgoQw4
nuNStCNEqKw+NyqSuoIl5JA=
=VzKD
-----END PGP SIGNATURE-----

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to