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.
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