Skip to main content
Participating Frequently
January 11, 2010
Answered

Using quotes or not when referring to button names in simulations

  • January 11, 2010
  • 4 replies
  • 14078 views

Hello!  My co-workers and I have different feelings on how button names should be displayed in text boxes in a simulation.

What is the best practice for this...?  If you have a text box that comes up that says "Click the OK Button".  What is the proper way to display this?

- Click the OK Button  (Just make OK bolded with no quotes)

- Click the "OK" Button (Put "OK" in double quotes)

- Click the 'OK' Button (Put the 'OK' button in single quotes)

One co-worker thinks you should use single quotes.  The other co-worker says that is gratically incorrect and we should use double quotes, or no quotes.

Also, do you always use bold to display the button name?

Is there a standard on this?  Which way is the best way to go?  Any info or insights would be greatly appreciated...

Thank you sooo much and have a great day!

Best Regards,

Francesca

This topic has been closed for replies.
Correct answer Captiv8r

Hi there

So you have a question that falls within the realm of Technical Communication. I follow many Tech Writing lists and see these all the time.

The answer to this is a quote:

The great thing about standards is that there are so many to choose from.

In nearly every discussion I've ever seen along these lines there is typically a single outcome. And that outcome is generally this. It really doesn't matter. Just be consistent in how you apply it!

Personally, my vote goes for one that is unlisted:

Click OK

Unless your user has no clue what a Button is, they clearly see it's a button, no?

Hopefully others will chime in here with better advice.

Cheers... Rick

Helpful and Handy Links

Captivate Wish Form/Bug Reporting Form

Adobe Certified Captivate Training

SorcerStone Blog

Captivate eBooks

4 replies

Known Participant
March 5, 2010

I'm with Rick.

Click OK

Press Play

Eat Pizza

Clean, simple and efficient.

Inspiring
January 14, 2010

Hi Francesca,

I'm with the others on this "Click OK to continue". The only rule you should always is consistancy. If you always refer to a button name in bold or in quotation marks of any type people will catch on.

A couple of additional pointers: if you're worried that your users aren't very computer savvy (like mine) put an "About this simulation" slide at the start. Use the slide to introduce the idea of on-screen buttons, and interactivity. Personally I use one type of text caption for information and another type to ask them to perform a task. Introducing these caption types as well as the idea of buttons at the start gives them a little more confidence going in, and improves their performance. It also gets around havign the talk about "the xyz button all the time"

Hope this helps

Niamh

Participating Frequently
March 2, 2010

Thank you sooo much for all of your responses and feedback...  They have been very

helpful.....  I really appreciate it!

Have a great day!

Best Regards,

Francesca

dannyhouk
Inspiring
January 14, 2010

@digitalchemist, I by and large agree with Captiv8r about the plethora of standards. In terms of a visual flow/user experience point of view, the "Click the OK button" verbiage flows the best. The single and double quotes seem superfluous since the boldface is already achieving the desired effect of drawing out button text. I would only use the quotes if you weren't boldfacing, and in that case would use double quotes. In writing and in coding single quotes are typically reserved for quotes within quotes (though again, to Captiv8r's point, you can probably find reasons to deviate from this rule of thumb).

As to Captiv8r's suggestion to only say "Click OK," that is also a context-based decision. In our simulations we explicitly say "button" in our text captions as you do because for our users, some are woefully uneducated in the ways of software and user interfaces so it makes sense to distinguish buttons from tabs, menus, text fields, etc. In a way, we're training them on a specific software application AND user interfaces in general. However, if you were writing to a tech-saavy audience then calling something a button that is obiously so could be a tad demeaning.

Captiv8r
Captiv8rCorrect answer
Legend
January 11, 2010

Hi there

So you have a question that falls within the realm of Technical Communication. I follow many Tech Writing lists and see these all the time.

The answer to this is a quote:

The great thing about standards is that there are so many to choose from.

In nearly every discussion I've ever seen along these lines there is typically a single outcome. And that outcome is generally this. It really doesn't matter. Just be consistent in how you apply it!

Personally, my vote goes for one that is unlisted:

Click OK

Unless your user has no clue what a Button is, they clearly see it's a button, no?

Hopefully others will chime in here with better advice.

Cheers... Rick

Helpful and Handy Links

Captivate Wish Form/Bug Reporting Form

Adobe Certified Captivate Training

SorcerStone Blog

Captivate eBooks