Documenting two similar interfaces

Subject: Documenting two similar interfaces
From: "Sarah Blake" <Sarah -dot- Blake -at- microfocus -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 23 Jun 2009 16:15:11 +0100

To save me reinventing the wheel...

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.

I'm not sure which of these will be the default; I suspect the ribbon
interface, but I don't know for certain. And while the placement of
functions within menus is similar between the two, it's not identical.

At the moment, I'm looking at basically doing the following:

1. From Furniture > Hatstand (or Interior > Furniture > Hatstand if
using the Classic interface)

...but the help is the approximate size of War and Peace, and giving
double directions for each task seems a bit cumbersome, especially when
(as seems inevitable) I'm going to have to go back through in a couple
of releases' time, removing one set.

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.)


Sarah Blake
Senior Technical Author
Micro Focus

Please consider the environment before printing this e-mail.

Micro Focus Limited is registered in England and Wales. Registered number: 01504593
Registered office: The Lawn, 22-30 Old Bath Road Newbury, Berkshire, RG14 1QN, UK
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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


Follow-Ups:

References:
WinHelp -- the platform that wouldn't die: From: Dan Goldstein

Previous by Author: Imbed callouts in graphic files for Epublisher
Next by Author: RE: Documenting two similar interfaces
Previous by Thread: WinHelp -- the platform that wouldn't die
Next by Thread: Re: Documenting two similar interfaces


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

Sponsored Ads


Sponsored Ads