RE: User Manual par excellance

Subject: RE: User Manual par excellance
From: "Bonnie Granat" <bgranat -at- granatedit -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 20 Sep 2005 11:35:21 -0400


Peggy Lucero writes:

> OK, I've gotten feedback from boss about the User Manual.
> Complaint is
> first 5-7 pages just don't grab and pull the reader in.
> I've been told that it needs more purpose and focus.

Peggy, I think the way to go is to have a person who is an expert at
critiquing technical books evaluate your existing manual and offer concrete
suggestions about how to improve it. Your own review of myriad existing
"successful" manuals is an enormous task that in the end may not bring you
anywhere near where you really want to be.

You want to know why your boss feels the manual isn't as good as it could
be. Looking at zillions of manual examples isn't going to help you determine
what makes yours different or help you improve yours. There are just too
many variables.

So I strongly recommend that you get a developmental edit of your manual by
a qualified individual. If your organization doesn't have a staff editor,
there are people who do this for a living and you could probably get a
review for under $250.

Bonnie Granat | http://www.GranatEdit.com
bgranat -at- granatedit -dot- com
Cambridge, Massachusetts, US
617-319-7461 (cell) or 617-354-7084



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

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.



References:
User Manual par excellance: From: Lucero, Peggy

Previous by Author: RE: XHTML/CSS lists?
Next by Author: RE: Content of Help Systems
Previous by Thread: Re: User Manual par excellance
Next by Thread: Re: User Manual par excellance


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


Sponsored Ads