RE: [great help example for a web-based app]

Subject: RE: [great help example for a web-based app]
From: "Ronan DEPAGNE" <ronan -dot- depagne -at- atempo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 22 Oct 2002 10:42:39 +0200


>
> Thanks, Michael. You were the only one who answered my
> posting so far. I guess I can't compete with more
> professional threads like the "personality type" one. Anyway,
> I noticed on a few sites that the help does not look like the
> "conventional" thing with the collapsible ToC, Index and
> Search tabs, it's rather another HTML page of the app with no
> context-sensitivity. Is this what the users expect?
> Erika
>
In my company, we have chosen to use the "conventionnal" type of help
for our web applications, in order to keep a consistent type of help,
whether the application is web-based or not.

I find that it also allows to separate conceptual information from
contextual information, making the help more easily readable, in my
opinion.

So we have "parameters" topics, reachable from the pages of the web
application (with popups, I love popups), and "concept" topics,
reachable from the TOC. This TOC is reachable from the "parameters"
topics, through a Show/Hide button.

But if the application does not need much explaination, I think that the
"parameters" topics could be enough, which allows you to use simple html
pages.

In any case, I think the help for a web application should open in a
different window.

Hope this helps

----------------------------------------------------------------------
Ronan DEPAGNE, office +33 (0) 1 64 86 83 00
Technical Writer, Documentation Department
ronan -dot- depagne -at- atempo -dot- com
Atempo S.A. (formerly Quadratec S.A.)
Les Boreales, 2, avenue de Laponie
91951 Courtaboeuf Cedex, France www.atempo.com

"Time Navigator, the software platform for high-performance Backup and
Restore services"
----------------------------------------------------------------------


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Buy ComponentOne Doc-To-Help 6.0, the most powerful SINGLE SOURCE HELP
AUTHORING TOOL for MS Word. SAVE $100 on the full version and $50 on the
upgrade. Offer ends 10/31/2002 (code: DTH102250).
http://www.componentone.com/d2hlist1002

All-new RoboHelp X3 is now shipping! Get single sourcing, print-quality
documentation, conditional text and much more, in the most monumental
release ever. Save $100! Order online at http://www.ehelp.com/techwr-l

---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.



References:
RE: [great help example for a web-based app]: From: Erika Yanovich

Previous by Author: Related Topics Control problem
Next by Author: RE: [great help example for a web-based app]
Previous by Thread: RE: [great help example for a web-based app]
Next by Thread: Re: [great help example for a web-based app]


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


Sponsored Ads