Re: What is not mandated is forbidden

Subject: Re: What is not mandated is forbidden
From: Fred Wersan <fwersan -at- mak -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Fri, 20 Jun 2014 06:54:20 -0400

Kevin wrote:
Does everyone subscribe to the notion that customer docs should contain only what is necessary?

Is there a place for material that is good to know, or that might reduce customer inquiries, but is not necessarily critical to performing a task?


1. What is your definition of necessary - and for which of your customers? A newbie, or someone who has used your type of software for years? Someone who likes lots of conceptual background, or someone who just wants to see procedures? Your target for information load is somewhere between the extremes. I tend toward more info. People who don't want it can ignore it. People who need it will find it.

2. Yes. Absolutely. Customer inquiries are expensive. Adding a note or an extra explanatory section is cheap by comparison.

Fred

--
Fred Wersan
VT MAK, Principal Technical Writer
150 Cambridge Park Drive, 3rd Floor, Cambridge, MA 02140
857-209-3469 fwersan -at- mak -dot- com

Where Live, Virtual, and Constructive Simulation Meets the Web
www.mak.com/weblvc



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Doc-To-Help 2014 v1 now available. SharePoint 2013 support, NetHelp enhancements, and more. Read all about it.

Learn more: http://bit.ly/NNcWqS

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

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


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: Separate Guides?
Next by Author: Re: Surface and Tech Writing
Previous by Thread: Re: What is not mandated is forbidden
Next by Thread: Re: What is not mandated is forbidden


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

Sponsored Ads


Sponsored Ads