Re: Release note Q

Subject: Re: Release note Q
From: Jeff Kontur <Jeff -at- jeffreykontur -dot- com>
To: Erika Yanovich <erika_y -at- rad -dot- com>, TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 15 Jan 2020 11:50:17 +0000

That would vastly improve readability. Another approach: include all headings but if there are no substantive changes, say so. Just 2-3 words, using the same verbiage each time. That way, no one can possibly assume changes were made and you simply “forgot” to mention them.

Jeffrey Kontur
“The Storytelling Copywriter”
+1 302-367-5951
Jeff -at- thestorytellingcoptwriter -dot- com
www.thestorytellingcopywriter.com


________________________________
From: techwr-l-bounces+jeff=jeffreykontur -dot- com -at- lists -dot- techwr-l -dot- com on behalf of Erika Yanovich <erika_y -at- rad -dot- com>
Sent: Wednesday, January 15, 2020 2:40 AM
To: TECHWR-L
Subject: Release note Q

While making some changes to the contents of release notes, we started questioning the entire concept. Is the RN a snapshot of the current situation, or just a "what's new" since the previous one? For example, we have a Compatibility heading. In the snapshot scenario, the text under it remains mostly unchanged through the versions (unless something relevant happens). In the "what's new" approach, if there is no change in compatibility, the entire section is omitted.

What do you all think?

Erika

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | https://techwhirl.com

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

You are currently subscribed to TECHWR-L as Jeff -at- jeffreykontur -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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | https://techwhirl.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


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


References:
Release note Q: From: Erika Yanovich

Previous by Author: Re: Ig Nobel documentation
Next by Author: Re: Ig Nobel documentation
Previous by Thread: Release note Q
Next by Thread: Re: Release note Q


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


Sponsored Ads