69 votes

For a command to increase something, should instructions refer to the "+" key or the "=" key?

Uhm, sorry. You refer to a =/+ key. But there is none on my keyboard. I think you should add a locale tag, and make sure your users only work within that locale.
knallfrosch's user avatar
  • 2,088
31 votes
Accepted

For a command to increase something, should instructions refer to the "+" key or the "=" key?

Based on conventions elsewhere, it is probably best to refer to it as the plus or + key. The +/- dichotomy is used in other apps and more likely to be encountered by your users before they use yours ...
Nathan Rabe's user avatar
  • 8,888
8 votes

Should I use the name "Enter" or "Return" key?

Return and Enter are different keys. Return often found as the main key, and Enter for the numeric key. Few software makes a difference between these. In Adobe Photoshop while editing text, Return ...
Liggliluff's user avatar
7 votes

For a command to increase something, should instructions refer to the "+" key or the "=" key?

If your software does not already map the + to a function, then just use both for this purpose, and only document the + in order to keep the established, familiar dichotomy. This is a great example of ...
jsejcksn's user avatar
  • 687
5 votes

How should I demonstrate a choice between two options in step-by-step instructions?

"On the computer, go to the employee website. Click the button that best describes you and the computer you're using:" On screen:
DarrylGodden's user avatar
  • 6,326
5 votes

Should I use the name "Enter" or "Return" key?

The Human Interface Guidelines (HIG) of the operating system of your program might give you a hint or the answer. There are HIG for Windows, macOS, Android and some more. For Linux things are a bit ...
John Doe IV's user avatar
5 votes

How do you describe "animation effects" in your Interaction Design? And in which phase do you do this?

I would call this affordance. Affordances provide strong clues to the operation of things. Good affordances in UIs usually leverage our knowledge of the physical world, and how we interact with ...
Franchesca's user avatar
  • 12.5k
4 votes

Annotating wireframes in sketch - how do you do it?

Assuming this is for dev handover/client engagement. There are a couple of things you can do here that I do/have done: Look into software: Zeplin is great for this as it automatically numbers ...
UIO's user avatar
  • 2,664
4 votes
Accepted

Usability or Accessibility

Yes, there are many details that go into anyone accessing something, but as most often used in UX, accessibility refers to a person with a disability having equivalent access to that of a person ...
MJBE's user avatar
  • 303
3 votes

How should I demonstrate a choice between two options in step-by-step instructions?

If you're going to do this as text instructions, be fully grammatical about it. Here's how I'd revise your text: Visit the course-management site: http://example.com Pick the appropriate option, ...
jamesnotjim's user avatar
3 votes

What's worse: no user guide or a useless user guide?

I'd say you're better off with no guide--and a good intuitive solution--than crappy guides. In fact, to the extent that you can build guidance into the design, you should. I recently shot a brief ...
jamesnotjim's user avatar
3 votes

What should I call these navigation buttons?

Why not show the user what buttons you're talking about in the documentation itself? Using the terminology @AndrewMartin suggested, you could include this simple reference image so that you can ...
maxathousand's user avatar
  • 19.5k
3 votes

User manual with screenshots for mobile devices?

Some thoughts: A manual is alright but try to see if you can rely better on in-app hints. Check Material design Onboarding, Feature discovery and Gesture education. - (..) serving whichever ...
Alvaro's user avatar
  • 16.8k
3 votes

User Manual vs How-to guide?

I'm not sure about common practice for this area, but the main thing that jars with me about this solution is that you are repeating the same type of content twice, and splitting it. If it's the same ...
David Sheridan's user avatar
3 votes

Should a SaaS Documentation portal be personalized?

Yes indeed. This is known as the Principle of Intentionality. You can learn about it in a psychology oriented article A Principle of Intentionality, and the UX-focused article Intentionality in User ...
Devin's user avatar
  • 38k
2 votes

How to document user interviews

Typical user interviews have two aspects: Documentation for conducting the research : This includes, at minimum the Interview Discussion Guide, Consent form, Screener questionnaire and Compensation ...
Anubha Bisht's user avatar
2 votes

Normative ordering for modifier key combinations

I'd say it's CTRL, SHIFT, ALT. Looking at the link @Marielle posted, I see no evidence for CTRL, ALT, SHIFT. Did I overlook something or did the docs change since the answer was posted in 2014? ...
Gandalf Saxe's user avatar
2 votes

Is video more effective than traditional text help?

My experience, in writing up much documentation and creating video content, is it depends. Some things require no more than a basic list of text instructions. Others are more nuanced and require video ...
Jamezrp's user avatar
  • 2,788
2 votes
Accepted

Screen shot of all google.com oneboxes

Found it. It was taco, not pizza. Thumbnail below, go to the original article for full resolution.
bjornte's user avatar
  • 422
2 votes

What's the best way to refer to a context menu in documentation?

I think that the best is to call the context menu by its name. Not only this is the correct term, but it's also self-explanatory. Your documentation should make sure at the very beginning that the ...
dr_'s user avatar
  • 693
2 votes
Accepted

What's the best way to refer to a context menu in documentation?

In an online or in-app documentation, it is possible to detect the OS and to tailor the message for the right OS. Though it might be wise to display a manual switch of the target OS if a user might ...
Aprillion's user avatar
  • 1,826
2 votes

User experience and Agile Modeling

What is being referred to here is perhaps a role called System Designer. Systems design is the process of defining the architecture, modules, interfaces, and data for a system to satisfy specified ...
Ren's user avatar
  • 3,196
2 votes
Accepted

What is the main difference in between a UI KIT and a Styleguide?

Does the difference in between them lies in that the styleguide includes design guidelines and best practices and the UI KIT is just showing the different components and their behaviors? Pretty much ...
Izhaki's user avatar
  • 32.6k
2 votes

Tech Writing: What to call list columns?

Based on brief discussion with the OP I'm posting an official answer: Details is the word you are looking for. For more explicit information it would be "Exported files details".
Mike's user avatar
  • 3,125
2 votes
Accepted

How to document continuous usability testing for monitoring over time?

I've seen SUS score tracked along with production deployments. Then you can track how new features and product changes affected usability over time. This helps to track the overall usability of the ...
Mike W's user avatar
  • 356
2 votes

What are some approaches for In-app UX for API documentation?

I think platforms like Storybook and CodePen provide examples of how to integrate technical details into a user interface that can be made more user friendly than it has been done in the past, which ...
Michael Lai's user avatar
  • 27.2k
1 vote

How often should the same hyperlink appear in a document?

In documentation, all links or references are numbered. Every time the given term (with a link) is encountered, a super-scripted number is used to denote it. On the first occurrence, the word is ...
Shreyas Tripathy's user avatar
1 vote
Accepted

How to design configurable scripts for non-programmers

(I would rather answer you on Gis.se, but I'll answer here it's not illogical regarding the end user side you need to enhance) I suggest you have a look at Python Toolboxes making for Arcgis, or in ...
gisnside's user avatar
  • 126
1 vote

What's worse: no user guide or a useless user guide?

we focus resources on one area of the application to provide a great self-learning experience If you have an intuitive UI, and also focus on specific workflows (hopefully ones that new users tend to ...
Alok's user avatar
  • 435
1 vote

How should I demonstrate a choice between two options in step-by-step instructions?

May be you can try above-mentioned design from UXfrom12 or you can try out these options. In the design shown below, I have used icons (just for representation, it can be replaced) for buttons. or ...
NB4's user avatar
  • 2,491

Only top scored, non community-wiki answers of a minimum length are eligible