text, usually about how to use a program.

learn more… | top users | synonyms

1
vote
1answer
35 views

What is the best way to document/describe a completely new product?

Describing a new feature, optimization, or new section of an existing app for engineering and the product team is fairly solvable. You can build on a specific existing point of reference and user ...
0
votes
1answer
46 views

Customer Journey testing [closed]

I'm new inside UX/CX design field, and I would like to know more info about customer journey mapping. I know that this process is to map the current customer journey also emotional mapping to find ...
4
votes
3answers
343 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 ...
6
votes
1answer
2k 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 from a user experience point of view, ...
3
votes
1answer
31 views

What are best practices for managing terminology changes in legacy software?

In a big redesign, there can be terminology changes and mapping to backend entities that needs to happen. What are the best practices for doing this? Also, for making documentation consistently ...
3
votes
2answers
50 views

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

It used to be that you could tell a user (in documentation or in onscreen prompts) to, let's say, "Click a button, or right-click to display a menu." Nowadays, there are multiple ways to display a ...
1
vote
2answers
65 views

Is video more effective than traditional text help?

Does anyone have experience with users' success or failure in using video or "task recording", as opposed to traditional textual help to complete their task or get more information? Additionally, ...
1
vote
1answer
52 views

User Manual vs How-to guide?

I am working on specifying documentation for a soon to be released SaaS tool. Some parts of it are very technical and will require an in-depth explanation of how it works. Conceptually I was ...
7
votes
4answers
369 views

Should an API documentation include When-to-use and when-not-to-use list?

The target user base for the problem described below is one of the most neglected and underrated one - Programmers/Developers/Coders. Consider, for example, this java doc which is explaining about ...
12
votes
3answers
545 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 ...
1
vote
3answers
187 views

UX/UI Documentation

In the next few weeks I'll be working on a project that teaches students how to program and design apps for Android Wear, tablets, and TVs. I'll be there as a UI and UX consultant, and will have about ...
8
votes
5answers
5k 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 ...
4
votes
4answers
5k views

Should I use the name “Enter” or “Return” key?

I'm trying to list the what various keys do inside the documentation for my CLI program, but I'm not sure what to refer to this key as. It is commonly referred to as either Enter or Return, but which ...
1
vote
5answers
179 views

How to write a perfect style guide [duplicate]

I'm developing a sort of a theme with a set of pre build components with is such as, styled data tables, input forms and etc... This is developed for internal usage in my company and I would like to ...
2
votes
1answer
42 views

Is it okay to have a random “notes” section in your documentation?

I started collecting from users of my project about the problems they face while using it and decided to put it into the documentation. Since right now it's just a single "README" document, I put it ...
6
votes
2answers
318 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 ...
3
votes
2answers
129 views

Is using a wireframe instead of a screenshot acceptable in technical work?

When putting screenshots of an application in technical work (such as a manual for end users), most screenshots will require editing to be usable. Extraneous UI elements may need removed, spacing may ...
1
vote
1answer
96 views

Characteristics of UX briefs

In your experience, what should a good UX brief include? What is the information you need to start work on a project?
3
votes
4answers
87 views

How would I instruct a reader to push a button with an ellipsis at the end?

I am writing some documentation and want to instruct a user through a process. During the process the user should click a button to open another screen. I am unsure how to document this as the ...
7
votes
2answers
4k 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 ...
0
votes
1answer
53 views

What help systems (KB's) are mostly used in bigger companies? [closed]

I know the first answer would normally be NO help system at all. make your UI as intuitive as possible. second would probably be about studies showing no one reading help files and the better option ...
3
votes
2answers
184 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 ...
6
votes
4answers
135 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 ...
4
votes
2answers
580 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 components/...
2
votes
2answers
373 views

How to best spec animations/transitions for engineering team handoff

I have an app prototype built using Pixate which demonstrates the entire flow of the app I am working on. There are transitions between views and animations for certain elements on the page. I have ...
1
vote
2answers
231 views

What would you call a group that contained UX, training and documentation?

What would you call a group within an organization that contained UX responsibilities as well as training and documentation? Marketing and product groups already exist outside of this entity... trying ...
0
votes
1answer
35 views

documenting a web app [duplicate]

My company is trying to improve the UX in our system. It's web based app, full with features. The system development started 8 years ago, but it was never documented, and our programmers/support team ...
2
votes
1answer
78 views

Help! I need something better than MS word for my UX spec docs [closed]

My team and I have been using MS word to deliver UX specs to our developers. Our documents include a section for: final visuals, content, wireframes, interaction notes, and business analysis flows. ...
2
votes
4answers
2k 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 ...
26
votes
6answers
2k 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 ...
2
votes
3answers
124 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 ...
28
votes
9answers
15k 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 ...
7
votes
4answers
133 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 ...
21
votes
7answers
2k 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 ...
2
votes
1answer
230 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. ...
27
votes
2answers
6k 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 ...
10
votes
5answers
4k 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 ...
1
vote
1answer
87 views

How to perform user research on application help/documentation?

I'm interested in doing some user research to see how documentation/help is being used in our enterprise web app, and I'm not sure what the most effective method would be. I'm not looking to find ...
14
votes
5answers
5k 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, ...
1
vote
1answer
147 views

How to document multiple interactions

Is there a best practice on how to document complex or layered interactions like the ones used in the native Mail app of iOS8? How is it possible to document in a clear way complex interactions and ...
1
vote
1answer
42 views

How can I best give PC requirements?

I'm working on documentation for a remote connection solution in my company. We've all seen lists like the following... PC Requirements 2 GB RAM dual-core processor high-speed ...
4
votes
2answers
132 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 ...
2
votes
6answers
174 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 ...
0
votes
1answer
61 views

Reducing web app documentation [closed]

Does anyone know of any good research showing the benefits of designing for better usability and less documentation? We all know that good usability should require little if any documentation. ...
1
vote
2answers
147 views

“We” vs. “You” in documentation

I am writing a tutorial that describes a configuration of a linux server. It will be published on the internet. Quite often I want to write something like this: In this chapter we will configure ...
20
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, ...
10
votes
4answers
326 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?
5
votes
3answers
195 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 ...
1
vote
2answers
261 views

How to approach user documentation in a maintainable, but user-friendly way?

Question What approach should be taken when designing end-user documentation for a large/corporate (web-based) software system? Is there industry best-practice that combines good UX with ...
4
votes
1answer
291 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 ...