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

Re: minimalist manuals

Subject: Re: minimalist manuals
From: Bruce Byfield <bbyfield -at- axionet -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 17 Sep 2001 13:57:49 -0700

Kane, Beth wrote:


I'm a strong believer in keeping the main docs as minimal as possible, while
providing links or cross-refs to further details in other places. The
details should be available, but they should not obscure the main points! I
think this technique accommodates all readers' problems and learning styles.


Generally, it's hard to disagree with the minimalist philosophy - but it's also hard to see anything special about the idea. To me, conciseness is a goal in any writing.

Personally, though, I'm not a fan of links or cross-references to achieve that conciseness. If you assume that most users are scanning for information, being referred elsewhere is a distraction and annoyance - even if that elsewhere is only a mouse-click away. So, while conciseness may be a virtue, I prefer not to achieve it at the expense of a document being as self-contained as possible. I'll use links and cross-references, but only for related or peripheral material, and never for anything essential to the topic.

--
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:
RE: minimalist manuals: From: Kane, Beth

Previous by Author: Informing Users of Alternatives (was: How much do people need to be told ...?)
Next by Author: Re: Minimalist manuals: a misconception
Previous by Thread: RE: minimalist manuals
Next by Thread: RE: minimalist manuals

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

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

Sponsored Ads