[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: How much do people need to be told in documentation?

Subject: Re: How much do people need to be told in documentation?
From: Bruce Byfield <bbyfield -at- axionet -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 17 Sep 2001 10:12:22 -0700

Hart, Geoff wrote:


The standard rule of thumb for such things is emphasize only one way to do
things in the text, but provide a list of shortcuts and alternatives
somewhere

While I generally agree with this rule,I've made an exception in the last few years for documentation aimed at Linux beginners. I had two reasons:


- I wanted new comers to realize the full range of options.

- More experienced Linux users, who might also use some of the material, are both completists and individualistic in their work methods. In other words, they want to know all the options, and dislike being herded (as they would see it) towards using one method only.

This second reason is, in fact, my largest qualm about using only one method in the text. If only menu commands are mentioned, then the majority of users may only know the menu commands. They may never learn the keyboard commands, which are often more efficient.

--
Bruce Byfield 604.421.7177 bbyfield -at- axionet -dot- com

"Writing is an occupation in which you have to keep proving your talent to those who have none."
- Jules Renard


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

A landmark hotel, one of America's most beautiful cities, and three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe. http://ieeepcs.org/2001/

+++ Miramo -- Database/XML publishing automation. See us at +++
+++ Seybold SFO, Sept. 25-27, in the Adobe Partners Pavilion +++
+++ More info: http://www.axialinfo.com http://www.miramo.com +++

---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.

References:
How much do people need to be told in documentation?: From: Hart, Geoff

Previous by Author: Tool for Cleaning Up HTML
Next by Author: Informing Users of Alternatives (was: How much do people need to be told ...?)
Previous by Thread: How much do people need to be told in documentation?
Next by Thread: RE: How much do people need to be told in documentation?

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

What this post helpful? Share it with friends and colleagues:

Sponsored Ads