text, usually about how to use a program.

learn more… | top users | synonyms

38
votes
6answers
3k views

If nobody reads Privacy Policies or Terms and Conditions, why not change them?

Once I read that if you were to read all the Terms and Conditions, Privacy Policy and similar documents that you ideally need to read before using software or online services in a given year, you'd ...
27
votes
2answers
4k views

Best practices for UI that introduces new users

I'm working on an onboarding UI to help new users get familiar our platform and I was thinking about some good ways to implement it. From what I have come across so far, it seems that many interfaces ...
26
votes
6answers
1k views

Should I use the terminology left/right click?

When instructing users which mouse button to click an element with, it seems standard practice to use the phrase 'left/right click': To download the file, 'right click' the link and choose 'Save ...
23
votes
9answers
8k views

Documentation - do we “Click”, “Push”, “Press” or “Select” a button on a touch-screen interface

I'm writing some documentation for a web-based application that will run on Android tablets at the factory at which I am employed. I am having trouble wording the steps where the users must interact ...
22
votes
8answers
846 views

How can I make my UX work more “fun”? [closed]

I work as a User Experience Specialist at a relatively big company (400-500 employees), I sit here all day mostly cranking out big UX documents telling other people what they should do with their ...
21
votes
7answers
1k views

Best way to display code to non-programmers

I'm asked to analyze the program responsible for printing our invoices. (Via SAP script) This program is pretty old and contains more than 4.000 lines of code. It sets a lot of different variables ...
19
votes
6answers
2k views

Does providing screenshots help with documentation manual?

I am documenting the site administrator and content creator roles for my web application which I am working on. The documentation manual walks the readers through how to add, delete, update members, ...
18
votes
4answers
2k views

Enterprise UI standards

I'm in the process of creating a set of UI standards for a large enterprise, for multiple overlapping services (websites, mobile apps, internal systems and extranets). This is the first time I've ...
13
votes
5answers
4k views

UX style guide techniques

I've recently started a major redesign for a large web-based financial tool. To aid future development, I'm planning on generating a UX style guide that outlines best practices for things like forms, ...
13
votes
2answers
22k views

example of a good software design document

Anyone got any online examples of good software design documents. I want personas, goals, scenarios and all that good stuff. I wish Cooper would have included a document with his books.
12
votes
3answers
455 views

Interactive 'page turn' documents - the case against using these?

What do people feel about interactive page turn documents? Here's an example (I'm not focusing on this report specifically - just happened to be an example I knew off the top of my head). Do these ...
10
votes
1answer
455 views

Why do US food labels intermix desirable and undesirable properties without distinction?

I find it remarkable that the US FDA, after years of tweaking and no doubt lots of time and money invested, could only come up with a food label that is terribly confusing! The left side shows a ...
9
votes
5answers
3k views

Which type of help system is best?

At my company we create Windows based desktop applications. In the past, we have created .chm files for our help documentation and have been happy with it. We have now been faced with some issues ...
9
votes
4answers
308 views

Does UX apply to other documents, such as Word or Spreadsheets?

Does UX apply to documents such as a Word document, or a PowerPoint presentation? In other words, should the writer take into consideration the readers' experience of the document?
9
votes
4answers
1k views

Does using bold font for keywords and key points increase readability of user manuals?

I find myself writing quite a lot of articles, user manual-like documents, as well as posting hundreds of questions on stackexchange sites. Over time, I developed a certain style of writing, which ...
9
votes
2answers
457 views

Full lifecycle, version controlled, UX documentation - Is this possible?

I'm currently trying to implement a usable UX documentation system , streamlining the flow of work between User Researchers/Usability specialists, Information Architects and Visual Designers. Just to ...
8
votes
4answers
387 views

Built in user guides

I want my web application to be self-explanatory. There are input fields and whole pages which need some paragraphs of explanation. How to integrate these user guides to my application? How to make ...
8
votes
5answers
3k views

Which one is better in our case if MDI is considered bad?

We are developing a financial reporting system, which is able to display many, I mean MANY, different reports from different angles. For example, the reports for position, deal, market risk, for ...
8
votes
3answers
636 views

How to document user interviews

What are the best practices to document interviews with users - do you just document the conclusions and take aways or do you do a full transcript or both?
7
votes
3answers
577 views

Points to be kept in mind while writing a document to redesign a web application?

I want to redesign a website and write a document explaining my design approach and thought process. I have recreated the layout and explained my suggested changes. I have the content for the document ...
7
votes
4answers
121 views

Building an archive of insights into our users

As UX Designers & Researchers we collect all this knowledge along the way, most of which is tied to specific projects. The crux though is that the insights can be highly relevant to later projects ...
7
votes
2answers
2k views

Industry standard for documenting IxD / UI Design Patterns?

What's the industry-standard way to document a design pattern? I have seen websites like ui-patterns.com and patternry.com that host and share design patterns, but when creating an reusing a design ...
7
votes
3answers
722 views

how to implement a style guide for a team of 2-4

I am reading Lean UX right now, and there is an idea inside I have never read before. It is about style guide. I would like to implement that but with as small a foot print as possible for the ...
7
votes
1answer
191 views

Quoting time and effort for UX research

Edit : I've added a little more detail to the main question here. There are many techniques and practices at our disposal to gain an understanding of the target audiences motivations and needs when ...
6
votes
3answers
3k views

How do you source your persona photographs?

Like many of you I'm sure, I consider the creation of user personas to be a crucial part of the UCD process, particularly when starting a new project. While we all have our own techniques and styles ...
6
votes
1answer
1k views

What nomenclature do you use for UI Elements

Having worked with multiple OSs, platforms and UI Kits I always run into the problem of how to consistently naming things be that larger structures with names like Widgets, Views, Forms, Controls or ...
5
votes
3answers
627 views

What is the usual way to specify a GUI?

What is the typical or most effective way to specify the design decisions and interaction patterns of a specific application's GUI? I began to realize I do not really know what the parts of a precise ...
5
votes
4answers
101 views

Documenting Rationale

I'm a UX architect working in house. In a nutshell wireframes are provided for our projects. We use JIRA as a way of tracking projects and confluence to document and archive them. Emails seem to be a ...
5
votes
3answers
189 views

Code reference site for developers

I'm looking for any UI / UX evidence for what makes a good code reference site. The information is a set of entries of classes (which contains properties and methods), subclasses, functions, and hooks ...
4
votes
2answers
252 views

Normative ordering for modifier key combinations

When indicating valid key modifier combinations to users, is there a "correct" or normative order in which to describe them? For instance, if you wanted the user to press shift and control and alt and ...
4
votes
3answers
139 views

When should you start working on help documentation on a large project?

I'm involved in a massive project that is turning 70+ antiquated systems into one system for a large company. The whole team and the executives at the company realize that this is a huge undertaking ...
4
votes
2answers
107 views

How can end users training be integrated to the UX plans?

For many systems, performance can be significantly improved by educating the end users. It might even be argued that training is required to achieve optimal system performance: IIRC, Robert N. ...
4
votes
3answers
194 views

Allow uploaded Word documents or require markdown?

I have a site for writing tutoring that currently requires the student to copy and paste from Word into an HTML textarea, removing all formatting. We've thought about letting the student upload the ...
4
votes
2answers
158 views

Why are there not more interactive design / style guides out there? Aren't they more user friendly?

It seems like only the larger companies working on development and design frameworks are producing interactive documents that provide information about the visual and interactive design ...
4
votes
3answers
227 views

What is the correct way to reference GUI controls when writing content and copy

I'm writing documentation. It's technical documentation and my audience should be tech-savvy. However, I have reservations about referring to UI elements in an interface by the terminology that ...
4
votes
1answer
553 views

User Manual vs User Guide vs Documentation vs Quick Reference vs Handbook

I am aware this has already been asked at http://english.stackexchange.com/questions/59224/what-are-the-differences-between-manual-guide-and-instruction however under a user experience point of view, ...
3
votes
2answers
184 views

Which is more usable FAQ or Help documentation?

Which is more usable FAQ or Help documentation for web services? I need to provide contextual help content for each page within the service. Also same content will be re-used in websites. In my ...
3
votes
1answer
144 views

Disabled button or enabled button with potential error message for actions with complex logic behind?

Say I have a button for a complex state machine which can be disabled for a number of reasons. I feel if I run some business logic CanActionBeDoneNow() and simply disable the button if it returns ...
3
votes
3answers
86 views

Name a feature with its UI label or with its underlying concept?

I work on a Java application that deals with cloud security. We have just introduced a "Forgotten your password?" link on our login screen. Due to the nature of the product, users have to turn this ...
3
votes
2answers
96 views

Idea to enhance the UX and the legibility of an internship report

I am in the last month of my last internship of my IT studies. And as in the five last years, I have to write an internship report (that almost nobody will ever read). The last one. And to give a ...
3
votes
1answer
162 views

Is the implementation of a stability index for a UI component or design pattern in a style guide useful/practical?

The concept of a stability index where the likelihood for the content, where it is code or a specification (e.g. in the documentation of the Node.js API) looks to be rather useful and can be adopted ...
2
votes
6answers
159 views

Use of technical terms

I am lead developer and in regular debate with marketing about use of technical terms. Currently users can search on string, date, and decimal. Users wanted to sum integer values in string so we ...
2
votes
2answers
113 views

Updating technical specifications after requirements changed?

We are working on a really large project. After we have created the wireframes and wrote the technical specification we started designing, slicing and programming. Technical specifications were ...
2
votes
3answers
119 views

Where should placed inline documentation/description for Web-based project?

I develop statical finance Web-based software and want to place a description of what histogram or table or chart was shown. Some charts have complicated calculation logic behind them, so user may ...
2
votes
3answers
151 views

What is the name of the document form where the text (content) for a User Interface is defined?

Like: Do we call it File or Document. Especially important if you make an interface that will be adopted for several languages.
2
votes
3answers
306 views

How should I design a small help system for a Windows application?

Context I've written a simple, business application which generates a report from information in a database. The only user input required are two file paths--one to a list of items to report on and ...
2
votes
3answers
49 views

Is a user requirement document commonly used? Is there an alternate name or more common type of document that already exists?

It is common for business analysts to create business requirement documents to detail the business process and rules that underpin how the system needs to behave. It is also common for solution ...
2
votes
4answers
1k views

User Interface Style Guides: Component Base vs Screen Based

We are in the process of updating some of our creative processes and outputs within our company and one of the items we have been experimenting with is the way we generate our UI Style Guide for the ...
2
votes
1answer
93 views

UX Documentation and sign off

I have a query on UX documentation. The company I work for build wireframes & interactive prototypes using Axure. However to document the work we use InDesign templates as the docs are branded. ...
2
votes
1answer
71 views

What is a good method for creating a guide for standardized markup?

I need to create a guide or wiki that outlines different standardized techniques for marking up reusable elements in our software. When adding new features our developers are often able to reuse or ...