Re: Hackos' minimalism seminar -- some insights

Subject: Re: Hackos' minimalism seminar -- some insights
From: Andrew Plato <gilliankitty -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 29 Nov 2002 13:08:54 -0800 (PST)


"Lois Patterson" <> wrote ...

> One thing she said seemed particularly germane to many
> discussions on the list, which I will paraphrase. Many
> technical writers are at the advanced beginner stage
> of proficiency with the software they are documenting.
> Thus, they spend a lot of time and space documenting
> what they are familiar with -- which tends to be
> navigating the menus. They do not necessarily take the
> time to document at a deeper level and how to
> effectively use the software in a task-based way. Less
> time should be devoted to instructions such as Click
> Save, and more time to understanding the software at a
> deeper level.

Gee, I've been saying that for over a decade and nobody pays to attend any of
my seminars.

Hackos (and me of course) are correct. Most writers document surface-level
instructions and do not take the time or effort to really think about HOW the
product/technology works and might be used. As such, most tech docs are endless
streams of pointless and worthless instructions.

This is usually caused by an over-emphasis on style and structure. Writers
spend all their energy and time building monuments of style and structure and
as such pay minimal attention to the content. The result - bad docs.

Andrew Plato



__________________________________________________
Do you Yahoo!?
Yahoo! Mail Plus - Powerful. Affordable. Sign up now.
http://mailplus.yahoo.com


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Check out SnagIt - The Screen Capture Standard!
Download a free 30-day trial from http://www.techsmith.com/rdr/txt/twr
Find out what all the other tech writers, including Dan, already know!

Order RoboHelp X3 in November and receive $100 mail in rebate, FREE WebHelp
Merge Module and the new RoboPDF - add powerful PDF output functionality
to RoboHelp X3. Order online today at http://www.ehelp.com/techwr-l

---
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.



Follow-Ups:

Previous by Author: Re: What would you say?
Next by Author: Standard Purity
Previous by Thread: Hackos' minimalism seminar -- some insights
Next by Thread: Re: Hackos' minimalism seminar -- some insights


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


Sponsored Ads