Re: What is More Important?

[Janice Gelb <Janice -dot- Gelb -at- Sun -dot- COM>]

richard -dot- melanson -at- us -dot- tel -dot- com wrote:
> May I ask everyone a question. What is more important, having the content of a manual written well or having the content of a manual technically accurate, and no they are not mutually exclusive :-) 
> 
> Please may I ask that you just pick one or the other, I know that we can list a myriad or reasons why each is important and at times mandatory, I am just asking everyone to decide and pick one. 
> 
> I am fortunate enough to have been on both sides of the fence. I was a Product Support Engineer for years working on Ion Implanters trying to use the manuals available and now I am the Writer of those manuals. 
> 

This is a pointless question: obviously
the main purpose of the manual is to
provide accurate information for using
the product. However, the clearer the
writing, the easier it will be for the
reader to understand the technical
information and use it.

The only purpose to this question that I
can see would be for someone looking for an
excuse for inelegant writing due to deadline
pressures forced by late technical changes.

-- Janice

***********************************************************
Janice Gelb          | The only connection Sun has with
janice -dot- gelb -at- sun -dot- com  | this message is the return address

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

Create HTML or Microsoft Word content and convert to Help file formats or 
printed documentation. Features include support for Windows Vista & 2007 
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot- 

To unsubscribe send a blank email to 
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot-  Visit
http://www.techwr-l.com/ for more resources and info.