Re: Open...

Subject: Re: Open...
From: Pro TechWriter <pro -dot- techwriter -at- gmail -dot- com>
To: kafkascampi <kafkascampi -at- gmail -dot- com>
Date: Thu, 18 Nov 2010 09:39:40 -0600

The Microsoft Manual of Style for Technical Publication (Third Edition, page
181) says never to include the ellipsis. It uses Open as the example, as
well.

And I quote:


(Excerpted) In general, avoid using an ellipsis(...) except in syntax lines
or to indicate omitted code in technical material... In the user interface,
the ellipsis is typically used to show truncation, as in a program name, or
to indicate on menus and dialog boxes that a dialog box will appear to
obtain more information from the user. Do not use an ellipsis in this
context in documentation.

*Correct*
On the *File* menu, click *Open*.

*Incorrect*
On the *File* menu, click *Open*....


The Microsoft Manual of Style is a great reference to have for any writer
and is well worth the money.

Best,
PT

On Wed, Nov 17, 2010 at 5:41 PM, kafkascampi <kafkascampi -at- gmail -dot- com> wrote:

> ANon TWer wrote: Got my redlines back. Nope. Manual has to match the
> software. If it says Open... in the UI, it has to say Open... in the
> manual.
>
> -------------
>
> We have similar button labels that use ellipses. I do not reproduce them in
> my help or manuals. It's confusing and can cause problems when the button
> label appears at the end of a sentence.... :)
>
> Chris
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> Create and publish documentation through multiple channels with
> Doc-To-Help.
> Choose your authoring formats and get any output you may need. Try
> Doc-To-Help, now with MS SharePoint integration, free for 30-days.
> http://www.doctohelp.com
>
> ---
> You are currently subscribed to TECHWR-L as pro -dot- techwriter -at- gmail -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/pro.techwriter%40gmail.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
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days.
http://www.doctohelp.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:
Open...: From: Anon TWer
Re: Open...: From: Richard Mateosian
Re: Open...: From: kafkascampi

Previous by Author: Re: MadCap Flare
Next by Author: Re: Open...
Previous by Thread: Re: Open...
Next by Thread: Re: Open...


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

Sponsored Ads


Sponsored Ads