[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: Best Practice for reviewing documents?

Subject: Re: Best Practice for reviewing documents?
From: Peter Neilson <neilson -at- alltel -dot- net>
To: TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 20 Dec 2005 12:46:33 -0500

Amen! I was both the writer and the SME for a book, and after I
had signed off the camera-ready copy someone in editorial took
it back and redid the whole thing, changing hundreds of instances
of "boolean" (the name of a data type) to "Boolean" on the grounds
that George Boole was a person, and thus the name required
capitalization. Unfortunately the language I was documenting
was case-sensitive, so hundreds of examples and definitions were
made incorrect. I did not catch the error until I saw the printed
book.

The client should get final sign-off. Genuine final, not fake final!

Geoff Hart wrote:

<<Boss says that after the client reviews document and makes their recommendations document should not be changed.>>

There's a sound reason for this: it's surprisingly easy to introduce significant errors into a document by making seemingly innocent changes that change the meaning. If the client has done a good job of the ...

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

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 now has RoboHelp Converter and HTML Source: Author content and configure Help in MS Word or any HTML editor. No proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -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%40infoinfocus.com

To subscribe, send a blank email to techwr-l-join -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.

Follow-Ups:

References:
Best Practice for reviewing documents: From: Lucero, Peggy
Best Practice for reviewing documents?: From: Geoff Hart

Previous by Author: Re: New Poll Question
Next by Author: Re: RoboHelp Baby
Previous by Thread: Best Practice for reviewing documents?
Next by Thread: Re: Best Practice for reviewing documents?

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

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

Sponsored Ads