Re: Change bars considered harmful (Was: Re: The worst doc problem ever?)

Subject: Re: Change bars considered harmful (Was: Re: The worst doc problem ever?)
From: "Eric Dunn" <dunn -dot- eric -dot- l -at- gmail -dot- com>
To: "techwr-l List" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 11 Apr 2008 12:29:10 -0400

Change bars should be applied to new content and content that has changed
technically only.

It's quite simple really. Change bars mean one of two things,
For a reviewer: Only look at this.
For a user: Pay particular attention to this. Don't work from memory.

On Tue, Apr 8, 2008 at 3:24 AM, Caroline Tabach <caroline -dot- tabach -at- gmail -dot- com>
wrote:

> However, I have been in a situation where I was working on at least 7
> user
> guides that had to be approved for the release, some of which were over
> 200
> pages long, and I had only changed a few sections in each user guide.
> The SME found in hard enough to review the books as it was, so I used the
> change bars to say, "this is all you have to look at". I know this is a
> compromise, as I would really like them to look at the complete book from
> time to time, but in this way, they at least looked at the material that
> was
> changed.
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! 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.


References:
The worst doc problem ever: From: Lech Rzedzicki
The worst doc problem ever?: From: Geoff Hart
Change bars considered harmful (Was: Re: The worst doc problem ever?): From: Peter Neilson
Re: Change bars considered harmful (Was: Re: The worst doc problem ever?): From: Janice Gelb
Re: Change bars considered harmful (Was: Re: The worst doc problem ever?): From: Caroline Tabach

Previous by Author: Re: amusing? docs story
Next by Author: RE: Let the grammar wars begin!
Previous by Thread: Re: Change bars considered harmful (Was: Re: The worst doc problem ever?)
Next by Thread: RE: Pilot Editing Study?


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


Sponsored Ads