Re: Troubleshooting Vs Release Notes

Subject: Re: Troubleshooting Vs Release Notes
From: "Dana Worley (MVP/JB)" <dana -at- campbellsci -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Wed, 01 Feb 2012 09:14:57 -0700

Troubleshooting is "my modem doesn't work -- how do I fix it?". Release notes are "we know there is a problem, here is a description". From my perspective, frequency is not a factor. If it's a "known issue" it's a known issue and is better suited for release notes (unless you have a known issues section in your user manual or other documentation). Troubleshooting is designed, in many cases, to take care of user error, improper configuration, and the like.

2 cents,

Dana W.

On 12:59 PM, Sion Lane wrote:

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?



--
*************************************
Campbell Scientific, Inc.
Product Manager, Software Products
*************************************
Microsoft Help MVP 2002-2012
*************************************
Jester's Baubles Fused Glass Designs
http://www.jestersbaubles.com
http://jestersbaubles.blogspot.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.
http://www.doctohelp.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-leave -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.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


Previous by Author: RE: New query: Scripting languages to support software testing
Next by Author: Re: Why I send these out -- was Re: Here's another winner - guess the pay
Previous by Thread: Re: Why I send these out -- was Re: Here's another winner - guess the pay
Next by Thread: TECHWR-L Premium Jobs, Events, and Announcements


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

Sponsored Ads


Sponsored Ads