Troubleshooting Vs Release Notes

Subject: Troubleshooting Vs Release Notes
From: Sion Lane <slane -at- ubq -dot- thrupoint -dot- net>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Tue, 31 Jan 2012 14:58:18 +0000

I'm wondering if anyone has any guidelines they use to decide what goes
into the Troubleshooting section of a guide and what is more appropriate in
the known issues/limitations section of a release note.

At the moment, I'm working on the theory of 'if it only happens
sometimes/on some devices/on some configurations, it goes in
Troubleshooting' and 'if it always happens whatever you do or whatever
you're using, it goes in the release note'.

Anyone got any better ideas?

Note: The information contained in this message may be privileged and confidential
and protected from disclosure. If the reader of this message is not the intended
recipient, or an employee or agent responsible for delivering this message to the
intended recipient, you are hereby notified that any dissemination, distribution or
copying of this communication is strictly prohibited. If you have received this
communication in error, please notify us immediately by replying to the message and
deleting it from your computer. Thank you. Thrupoint, Inc. - ubq

Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days.

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-leave -at- lists -dot- techwr-l -dot- com
or visit

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 for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at

Looking for the archived Techwr-l email discussions? Search our public email archives @


Previous by Author: Re: need a word - "don't bury it in the display and make it hard to find"
Next by Author: STC Montreal Chapter to Dissolve
Previous by Thread: Re: Need opinions: Camtasia versus Captivate
Next by Thread: RE: Troubleshooting Vs Release Notes

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

Sponsored Ads