RE: Documenting two similar interfaces

Subject: RE: Documenting two similar interfaces
From: "Dan Goldstein" <DGoldstein -at- riverainmedical -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 23 Jun 2009 11:31:22 -0400

Here's what I'd want, if I were the user:

Each Help screen should have a small link on the upper right for
switching between the instructions for Ribbon and Classic. (Examples
include the Page Options link on the Yahoo home page, the Edition link
on the CNN home page, etc.) The Help file remembers your current choice
not only while you navigate through the Help file, but also when you
close and reopen it.

> -----Original Message-----
> From: Sarah Blake
> Sent: Tuesday, June 23, 2009 11:15 AM
> To: techwr-l -at- lists -dot- techwr-l -dot- com
> Subject: Documenting two similar interfaces
> 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.)

This message contains confidential information intended only for the use of the addressee(s). If you are not the addressee, or the person responsible for delivering it to the addressee, you are hereby notified that reading, disseminating, distributing, copying, electronic storing or the taking of any action in reliance on the contents of this message is strictly prohibited. If you have received this message by mistake, please notify us, by replying to the sender, and delete the original message immediately thereafter. Thank you.


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:


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

Previous by Author: RE: IBM Style Guide online? RESOLVED
Next by Author: RE: Documenting two similar interfaces
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