Re: Documentation Deliverables for Complex Scenario?

Subject: Re: Documentation Deliverables for Complex Scenario?
From: Deborah Hemstreet <dvora -at- tech-challenged -dot- com>
To: TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>, Geoff Hart <ghart -at- videotron -dot- ca>, "DWerder -at- t-online -dot- de" <DWerder -at- t-online -dot- de>
Date: Thu, 02 Jul 2009 16:29:48 -0400

Hi All,

I want to thank you all for taking the time to give me some good thought
provoking answers. You've reminded me of some ideas I'd forgotten, and
supported some of my original reactions to the issues at hand.

I especially appreciated Geoff reminding me to think about
context/sensitive or embedded Help. The client has indeed begun to do
this, but there is room for improvement. So I will encourage them to
proceed, but make some suggestions.

Organization is indeed going to be the key here. As I learn about the
business processes and how they are handled via the SW, I will be sure
to pay attention to this.

My client believes strongly that their end-users need to have access to
information about what the SW is doing in the background. From what they
have said, I believe it's because of the sensitive nature of some of the
tasks. Clients want to be reassured that a process is handled in a
certain manner. Yes I agree with Geoff and others... I really don't
think the client wants to know what the SW is doing in the background.
What they really want to know is how to do something, and how they know
it is accomplished. I think I can provide the information the client
wants in a way that is more focussed on how the user's needs are met.

Finally, I believe that Doris's idea of a customizable Help landing page
is brilliant. If anyone has some suggestions or tips for how that could
be integrated with FlashHelp, please let me know. Doris shared a few
thoughts on this as well. I will see how the client reacts to this idea.

Of course, at the end of the day, it will all break down into funding,
and what is feasible at this time or not. I do know that my client has
already added some of my ideas to their list of future improvements. So
I am optimistic in the long run.

Thanks again for your suggestions and input.


Free Software Documentation Project Web Cast: Covers developing Table of
Contents, Context IDs, and Index, as well as Doc-To-Help
2009 tips, tricks, and best practices.

Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control!

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-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

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 for more resources and info.

Please move off-topic discussions to the Chat list, at:

Documentation Deliverables for Complex Scenario: From: Deborah Hemstreet
Documentation Deliverables for Complex Scenario?: From: Geoff Hart

Previous by Author: Re: Documentation Deliverables for Complex Scenario
Next by Author: Re: job-hunt weirdness
Previous by Thread: Documentation Deliverables for Complex Scenario?
Next by Thread: Re: Documentation Deliverables for Complex Scenario

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

Sponsored Ads