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.
Re: release notes for "new" product and cloud-based products
Subject:Re: release notes for "new" product and cloud-based products From:John G <john -at- garisons -dot- com> To:Sharon Metzger <sharon -dot- metzger -at- gmail -dot- com> Date:Thu, 07 Dec 2017 00:48:43 +0000
Hi Sharon,
I had to do this a couple of years ago. What we decided to do was to use
the RelNotes as a way to introduce the new versions of the most used and
most important features. We didnât compare/contrast old/new, and we didnât
include everything, but we did explain how the selected features worked in
the new version. We also provided links to the help system where more
information could be found. No negative comments received, so IMHO, thatâs
a win!
JG
On Wed, Dec 6, 2017 at 5:09 PM Sharon Metzger <sharon -dot- metzger -at- gmail -dot- com>
wrote:
> Hi folks --
>
> *What's new in a new product*: We're releasing a very new version of our
> product that resembles the old product, but is a new paradigm. I realize
> that I can't remember ever writing release notes for a new release. Our
> release notes typically have these sections: What's new (new features),
> Resolved issues (bug fixes), and Known issues. There won't be any resolved
> issues. There is a short list of known issues. But we're thinking about
> what to say for "what's new" -- a list of features, a descriptive intro to
> the product, a comparison to the old product... TPTB will make the final
> decision about messaging, but I'm looking for ideas to propose.
>
> *Cloud-based product release notes*: A separate but related question: Any
> best practices for release notes for cloud -- updating on a rolling basis,
> reduce friction, probably not as formal as our pre-cloud relnotes? (I'm
> deliberately leaving out our current process for now.)
>
> Thanks for any thoughts or pointers!
> Sharon
> sharon -dot- metzger -at- gmail -dot- com
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> Visit TechWhirl for the latest on content technology, content strategy and
> content development | http://techwhirl.com
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as vwritert -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
>
--
Sent from my iPad, please excuse any automatically created mis-corrections
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com