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: When is it too much information? From:"Cardimon, Craig" <ccardimon -at- M-S-G -dot- com> To:'Lynne Wright' <Lynne -dot- Wright -at- tiburoninc -dot- com>, 'yehoshua paul' <ysp10182 -at- gmail -dot- com>, 'tech2wr-l' <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Mon, 18 Feb 2013 15:21:31 +0000
Another question I'm always asking myself is, when is it too much information for one topic?
When should a topic that is chock full of goodies be split into two topics?
-----Original Message-----
From: techwr-l-bounces+ccardimon=m-s-g -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+ccardimon=m-s-g -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Lynne Wright
Sent: Monday, February 18, 2013 10:16 AM
To: yehoshua paul; tech2wr-l
Subject: RE: When is it too much information?
As a general rule, in a user guide, I wouldn't describe something that doesn't/won't happen.
BUT given that we're talking release notes, if the support guy thinks its worthwhile, I'd put it in. On the presumption that he knows the audience the best.
-----Original Message-----
From: techwr-l-bounces+lynne -dot- wright=tiburoninc -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+lynne -dot- wright=tiburoninc -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of yehoshua paul
Sent: Monday, February 18, 2013 10:07 AM
To: tech2wr-l
Subject: When is it too much information?
While reviewing the latest release notes that my company sends out every couple of weeks, one of the support guys suggested that I add the following words (or something similar) to one of the change descriptions: "The user does not need to do anything." What changed is information that was displayed in one area of the UI is no longer displayed. The support guy thought the users might think they need to do something, now that they no longer see this information.
I told him, if the users needed to do something, I would write this in the release notes like I did with some of the other changes, and include the relevant steps, or the appropriate reference to the online help. If I didn't write anything, why would the users think they need to do something?
His argument was that it doesn't hurt to add the sentence, and it may prevent confused customers from calling customer support.
What do you guys think? Would adding a superfluous sentence (in my opinion) help or hinder users.
Yehoshua
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
EPUB Webinar: Join STC Vice President Nicky Bleiel as she discusses tips for creating EPUB, the file format used for e-readers, tablets, smartphones, and more.
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 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
EPUB Webinar: Join STC Vice President Nicky Bleiel as she discusses tips for creating EPUB, the file format used for e-readers, tablets, smartphones, and more.
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
Information contained in this e-mail transmission is privileged and confidential. If you are not the intended recipient of this email, do not read, distribute or reproduce this transmission (including any attachments). If you have received this e-mail in error, please immediately notify the sender by telephone or email reply.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
EPUB Webinar: Join STC Vice President Nicky Bleiel as she discusses tips for creating EPUB, the file format used for e-readers, tablets, smartphones, and more.
