Re: User Manual par excellance

[Martin Bosworth <martinhbosworth -at- gmail -dot- com>]

> So just delete the first 5-7 pages and cut straight to the part with
> purpose and focus. I'm totally serious. Most tech doc introductions are
> completely dispensable, regardless of the skill or sincerity of the
> writer. If you want something to grab and pull the reader in, write a
> killer brochure.
>
> Mike O.

Peggy,

I agree with Mike here. Don't waste time with fancy, involved intros
or anything that detracts from what the manual is about--how to use
your widget. That doesn't mean you can't be entertaining in your
*tone*, but the focus should always be on the product.

Whenever I write user manuals, I always think first and foremost, "How
well does this achieve its goal of making the product easier to use?"
Anything that detracts from that goal can be removed.

Martin

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

Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l

Doc-To-Help 2005 converts RoboHelp files with one click. Author with Word or any HTML editor. Visit our site to see a conversion demo movie and learn more. http://www.componentone.com/TECHWRL/DocToHelp2005

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