Documenting buttons with ellipses

Subject: Documenting buttons with ellipses
From: Nina rogers <nrogers -at- interactsys -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 17 Jun 2004 14:45:59 -0400


Please help me to resolve a little debate that's going on in my office.

What is the correct way to document a command button with an ellipsis (e.g.,
"Save As ...")? I have always understood that the ellipsis should be omitted
in the written documentation, but my co-worker insists that the
documentation should be identical to what is seen on the screen. I find that
including the ellipsis tends to make a sentence harder to read, and I don't
think most people pay that much attention to ellipses anyway.

My version (with button name bolded): "Click Save As to assign a new name to
the document."
Her version (also with button name bolded): "Click Save As ... to assign a
new name to the document."

Which is correct? Or, which is more "acceptable"?

Nina Rogers
Technical Writer

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

SEE THE ALL NEW ROBOHELP X5 IN ACTION: RoboHelp X5 is a giant leap forward
in Help authoring technology, featuring Word 2003 support, Content
Management, Multi-Author support, PDF and XML support and much more! http://www.macromedia.com/go/techwrldemo

COMPONENTONE DOC-TO-HELP 7 PROFESSIONAL: From a single set of Word documents, create online Help and printed documentation. New version offers yearly subscription service, Natural Search, Modular TOC Utility, Image Map Editor, Theme Designer, Context String Editor, plus more. http://www.componentone.com/doctohelp .

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -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.



Follow-Ups:

Previous by Author: Re: FWD: Managing managers and cell phones
Next by Author: RE: Sanity Check on Logo
Previous by Thread: Re: White Paper Proposals
Next by Thread: RE: Documenting buttons with ellipses


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

Sponsored Ads


Sponsored Ads