Re: Documenting two similar interfaces

Subject: Re: Documenting two similar interfaces
From: David Castro <thejavaguy -at- gmail -dot- com>
To: Sarah Blake <Sarah -dot- Blake -at- microfocus -dot- com>
Date: Tue, 23 Jun 2009 11:27:42 -0400

If you can get buy-in from your programmers, you could potentially use
whatever conditional text features are offered by your development
environment to create two different outputs, and then the Help features (F1,
Help buttons, and Help menu) could select the correct help file for the
configuration that the user has opted for.

--
-David Castro
thejavaguy -at- gmail -dot- com

On Tue, Jun 23, 2009 at 11:15 AM, Sarah Blake <Sarah -dot- Blake -at- microfocus -dot- com>wrote:

> I'm currently working on a project where we're upgrading the UI to use a
> new 'ribbon'-style interface (a la MS Word), but users will also have
> the option to use the familiar 'classic' interface. The documentation
> will therefore need to deal with both.
>
[snip]

> ...but the help is the approximate size of War and Peace, and giving
> double directions for each task seems a bit cumbersome
>
[snip]

> If I have to, then I have to, but does anyone else who's gone through
> this process have any tips or suggestions? (The documentation format is
> CHM, created from XML source files.)
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.
http://www.doctohelp.com/SuperPages/Webcasts/

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! http://www.helpandmanual.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-unsubscribe -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.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


References:
WinHelp -- the platform that wouldn't die: From: Dan Goldstein
Documenting two similar interfaces: From: Sarah Blake

Previous by Author: Re: My URL being used?!
Next by Author: Google Wave--will it be a game changer?
Previous by Thread: Re: Documenting two similar interfaces
Next by Thread: RE: Documenting two similar interfaces


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

Sponsored Ads


Sponsored Ads