Hi all,
Going through our documentation, both printed and online, you will find
different information types:
- instructional information
- conceptual information (clarification of terms and context)
- functional descriptions
- examplary information
In the online help we are trying to reduce the functional descriptions
in favor of the instructional information which is more helpful for the
users. But I would like to go even further and propose
- to separate help topics in mere conceptual and mere instructional content
- to remove conceptual content from the help and collect it in a
printable document where the user can look it up when needed
- to formulate topic titles in such a way that the user recognizes
whether it contains more instructional or more conceptual content
- to use more examples, particularly in documentations for beginners.
What do you think of it? Do you have more ideas how to get a better
information mix in our documentation? Are functional descriptions
totally superfluous?
Thanks for you comments
Martina
--
[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]
