TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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
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.
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
Doc-To-Help 2014 v1 now available. SharePoint 2013 support, NetHelp enhancements, and more. Read all about it.