Re: Release note Q

Subject: Re: Release note Q
From: Shari Punyon <sharipunyon -at- gmail -dot- com>
To: Erika Yanovich <ERIKA_y -at- rad -dot- com>
Date: Wed, 15 Jan 2020 09:10:45 -0500

I generally think of release notes as whatâs new. If you have upgrade instructions, I would put the compatibility there, with a flag about whether any compatibility has changed, and at what version. Also obviously in any initial installation or specification documents.

> On Jan 15, 2020, at 2:39 AM, Erika Yanovich <ERIKA_y -at- rad -dot- com> wrote:
>
> ï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 sharipunyon -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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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: I need a better File Previewer
Previous by Thread: Re: Release note Q
Next by Thread: Re: Release note Q


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


Sponsored Ads