Re: disclaimer for small UI diffs in screenshots (of SaaS products) ?

Subject: Re: disclaimer for small UI diffs in screenshots (of SaaS products) ?
From: "B.J. Smith" <bjsmith -at- ucar -dot- edu>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Tue, 31 Jan 2012 07:48:58 -0700

Excellent point about not mentioning SaaS, which doesn't seem to be important in this context.

I'm all for not making excuses, too. Just state what the reader needs to know, as simply as possible.

On 1/30/2012 9:45 PM, Keith Hood wrote:

Sometimes the changes really do come so rapidly that the TW can't keep up.


I wouldn't even mention "SaaS" in the disclaimer. For one thing, there's multiple definitions of the acronym and if you are using one that doesn't match what your reader is thinking, he may jump to the conclusion that you are the one using the "wrong" definition, in which case the reader may erroneously downgrade his notion of your work's validity. For another thing, you can have constant ongoing changes in any kind of software, whether it's SaaS or not. Write something like "This software is updated weekly, so you may notice..."



________________________________
From: Peter Neilson<neilson -at- windstream -dot- net>
To: TechWR-L<techwr-l -at- lists -dot- techwr-l -dot- com>; Monique Semp<monique -dot- semp -at- earthlink -dot- net>
Sent: Monday, January 30, 2012 6:17 PM
Subject: Re: disclaimer for small UI diffs in screenshots (of SaaS products) ?

On Mon, 30 Jan 2012 17:50:59 -0500, Monique Semp<monique -dot- semp -at- earthlink -dot- net> wrote:

âBecause this is a SaaS application that weâre continually improving, you may notice slight differences ...
Nahhh. It's an excuse for something that happens in nearly all tech manuals anyway. Readers learn to live with that kind of stuff. If the changes are too glaring to ignore, don't excuse them--prevent them or fix them.

You could possibly say, "This manual documents the product at Rev. 13.34.5a. The examples may vary slightly in other revisions."
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days.
http://www.doctohelp.com

---
You are currently subscribed to TECHWR-L as bjsmith -at- ucar -dot- edu -dot-
To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/bjsmith%40ucar.edu


To subscribe, send a blank email to techwr-l-join -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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days.
http://www.doctohelp.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
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -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:
disclaimer for small UI diffs in screenshots (of SaaS products) ?: From: Monique Semp
Re: disclaimer for small UI diffs in screenshots (of SaaS products) ?: From: Peter Neilson
Re: disclaimer for small UI diffs in screenshots (of SaaS products) ?: From: Keith Hood

Previous by Author: Re: Another Punctuation Question
Next by Author: Re: Disagreeing with house styles
Previous by Thread: Re: disclaimer for small UI diffs in screenshots (of SaaS products) ?
Next by Thread: Re: disclaimer for small UI diffs in screenshots (of SaaS products) ?


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


Sponsored Ads