TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Pardon me if someone already mentioned this, but another way to search for
this topic in the archives (or anywhere on the Web) would be under
"downsizing" documentation. That was a popular term for quite a while. Years
ago, I attended one of J.Hackos' workshops on downsizing your docs.
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.
One problem with all-in-one, oversized docs is the mere sight of them can
intimidate readers into running to the phone rather than trying to find
their own solutions.
The first, breakthrough minimal doc I observed was back in 1995 -- the
instruction manual for Windows 95. It was so tiny and was such a departure
from previous docs that it made everybody hopping mad! But the full story
was available in the Win95 online help. Since '95, people have gradually
been getting used to minimal docs that point you to other sources.
(Disclaimer: I am not saying that Win95 booklet was a GOOD manual; just that
it was a noticeable departure from the norm.)
Beth Kane
TW, NCS Learn's Technical Services Org.
beth -dot- kane -at- ncslearn -dot- com
-----Original Message-----
> ...I'm currently writing my diploma thesis ... about
> minimalist manuals (the concept by John M. Carroll) compared
> to "ordinary" manuals...
> What I would like to know:
> 1) Is minimal design discussed in this list ? Is it a topic or not ?
> 2) Does anyone know of good examples of minimal manuals
> that can be bought or looked at online ?
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.comhttp://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.
