Re: Book? Or Books?

Subject: Re: Book? Or Books?
From: "Robert Plamondon" <robert -at- plamondon -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 25 Apr 2003 07:47:10 -0700


It depends. I use these rules of thumb:

1. Books that are delivered by a salesman should be all under one cover, so
he can't leave one behind by mistake. Salesmen are too busy to be able to
keep straight every volume of a seven-volume set. So are customers.

2. If there are multiple volumes, any reader should know instantly which
information is in which volume. If this can't be done, the division
shouldn't be made.

3. Long documents are intimidating, so the introductory material that serves
to sell the client on the product should be in a separate, shorter volume,
no more than 32 pages long. Sixteen is better.

4. Fast-changing documents like release notes shouldn't be part of more
stable documents.

5. Some documents are more likely to be written than others. When
documenting semiconductors, the statement that "We'll take this out of the
data book and turn it into an app note" is equivalent to, "We'll drop this
information on the floor and never pick it up again." This is so reliable
that it's best to suggest, "Let's write up the app note and THEN take the
material out of the data book."

-- Robert
--
Robert Plamondon
President, High-Tech Technical Writing
robert -at- plamondon -dot- com
http://www.plamondon.com/HIGHTECH/homepage.html
"We're Looking for a Few Good Clients"




^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Last chance to order RoboHelp X3 and receive a $100 mail-in rebate,
PLUS free RoboScreenCapture and WebHelp Merge Module. Offer expires
4/30/03! Order here: http://www.ehelp.com/techwr-l

Help celebrate TECHWR-L's 10th Anniversary starting this month!
Check out the contests at http://www.raycomm.com/techwhirl/special/contests/
Happy birthday to you, happy birthday to you, happy birthday 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.



Previous by Author: RE: Visio to PDF Printing problem
Next by Author: RE: On PDFs
Previous by Thread: Duh! Can't create merged index for master project in RHX3
Next by Thread: Re: Thank God for good documentation


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

Sponsored Ads


Sponsored Ads