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.
On Mon, Jun 16, 2008 at 9:50 AM, Paul Hanson <phanson -at- quintrex -dot- com> wrote:
> No way. Don't tell the user anything like this. Three things:
>
> 1) The user is going into the help system to find information. You're
> telling them, first thing, before they even can look for info, that they may
> not find it? Why even look? Why ever look in the help if they know it could
> possibly be out of date?
>
> 2) Have a feedback form on the topic. Let the user use that if they
> find something unhelpful.
>
> 3) You don't need to tell them to contact Support. They will do so
> anyways if they can't find the info **if** they're trained to look in the
> help in the first place.
>
>
>
> All you can do is your best – the version of help that installed with the
> app is the latest version and you are always updating it. Period. Don't
> instill doubt in your users that they won't even bother to look in your
> help, even if you get your dev processes corrected and actually have
> up-to-date online Help.
>
>
>
> Paul
>
>
>
> *From:* Zen C [mailto:zenizenc -at- gmail -dot- com]
> *Sent:* Monday, June 16, 2008 8:40 AM
> *To:* Paul Hanson
> *Subject:* Re: RoboHelp Q
>
>
>
> Well we want the user to know that the Help is not up to date with the
> application all the time. The program is constantly changing cos it is a new
> product. Mgt wants some help out there cos there are some using the product
> already. Every time the Help is ready to update there is something or the
> other that is changed.
>
> Do you think I should just include a note on the main page stating the
> following:
>
>
>
> "Please be advised that the contents of the Help system may not be up to
> date with the current application. We make every effort to maintain the Help
> System as frequently as possible. However, there may be a delay in our
> ability to provide the most current content to you. Please contact the
> Support department if you should need assistance or require further
> information."
>
>
>
> Some way to keep the user informed so that they don't complain. The concept
> here is put whatever information out there, even though it might not be up
> to date or may change again and again. I have tried to follow the process of
> waiting to put out information until the product is somewhat stable and then
> do releases, but it doesn't work that way here.
>
>
>
>
>
>
>
> On Mon, Jun 16, 2008 at 9:25 AM, Paul Hanson <phanson -at- quintrex -dot- com> wrote:
>
> Every time someone accesses the help, which they don't want to go into in
> the first place, you want to tell them something that can't be incorporated
> in to the online Help topics? What could be possibly that important that you
> need to tell them the same thing *each* time they access the help?
>
> Don't do this. Incorporate you content into the topics. I'd use your help
> once and then never again.
>
> Paul
>
>
> -----Original Message-----
> From: techwr-l-bounces+phanson=quintrex -dot- com -at- lists -dot- techwr-l -dot- com [mailto:
> techwr-l-bounces+phanson <techwr-l-bounces%2Bphanson>=quintrex.com@
> lists.techwr-l.com] On Behalf Of Zen C
> Sent: Monday, June 16, 2008 8:21 AM
> To: techwr-l List
> Subject: RoboHelp Q
>
> Hi,
>
> I want to insert a disclaimer as a message that pops up when the Help
> button
> is clicked. I want the user to read the message before going into Help. Is
> there anyway I can do this for web help or do I have to get a programmer to
> code something for it to work.
>
> Have a great day!
>
> Zen
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> Create HTML or Microsoft Word content and convert to Help file formats or
> printed documentation. Features include support for Windows Vista & 2007
> Microsoft Office, team authoring, plus more.
>http://www.DocToHelp.com/TechwrlList<http://www.doctohelp.com/TechwrlList>
>
> True single source, conditional content, PDF export, modular help.
> Help & Manual is the most powerful authoring tool for technical
> documentation. Boost your productivity! http://www.helpandmanual.com
>
> ---
> You are currently subscribed to TECHWR-L as PHanson -at- quintrex -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit
>http://lists.techwr-l.com/mailman/options/techwr-l/phanson%40quintrex.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.techwr-l.com/ for more resources and info.
>
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-