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:Kathleen MacDowell <kathleen -dot- eamd -at- gmail -dot- com> To:yehoshua paul <ysp10182 -at- gmail -dot- com> Date:Mon, 18 Feb 2013 09:34:17 -0600
I'd put in some type of note about obviously changed interfaces, on the
chance customer support will start getting calls about the program being
broken. If it isn't something obvious to the user, at whatever level, then
I wouldn't. In some sense, the developer and/or support people would be a
good judge of that. I also think you're lucky to be getting suggestions
from support. In my experience they don't share too much, but that's
probably because support was paid :-)
Re Craig's question: Can you give an example of what you're thinking about?
Obviously there are times, but it seems hard to think of an explicit
rule/guideline aside from what one would use for clear, informative
writing. Maybe one rule would be when the topic can be approached from
several directions. Then maybe change the heading and divide into
sub-topics?
On Mon, Feb 18, 2013 at 9:07 AM, yehoshua paul <ysp10182 -at- gmail -dot- com> wrote:
> 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.
>
> Learn more: http://bit.ly/12LyN2z
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as kathleen -dot- eamd -at- gmail -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
>
--
Kathleen MacDowell
kathleen -dot- eamd -at- gmail -dot- com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
