text, usually about how to use a program.

learn more… | top users | synonyms

-2
votes
0answers
22 views

How much does a DITA solution cost? [on hold]

I'm looking to buy some software for technical document authoring with DITA. The tech writing group will have at least 5-10 users, writing 100-pages long documents for several products in various ...
1
vote
1answer
41 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. ...
4
votes
1answer
78 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 ...
1
vote
1answer
78 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 ...
0
votes
1answer
35 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 ...
0
votes
1answer
54 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 ...
3
votes
2answers
69 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
144 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
41 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. ...
0
votes
0answers
21 views

Is the implementation of a stability index for a UX component or 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 ...
3
votes
1answer
150 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, ...
4
votes
2answers
240 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 ...
19
votes
9answers
5k 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 ...
0
votes
0answers
62 views

What are some ways to organize documentation links in a portal?

I really like the documentation pages for AngularJS and Bootstrap, but they have a left navigation with contents on the right splayed out. I don't have that luxury, and as it is currently, the two ...
0
votes
2answers
94 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 ...
18
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, ...
0
votes
0answers
28 views

As documented their animations and interactions? [duplicate]

Has anyone documented their animations, effects, and interactions to make them understandable as possible to designers and programmers. My goal is to help designers and programmers create a final ...
1
vote
4answers
724 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 ...
0
votes
3answers
244 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 ...
23
votes
2answers
3k 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 ...
0
votes
2answers
107 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 ...
5
votes
3answers
179 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 ...
3
votes
1answer
103 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 ...
26
votes
6answers
908 views

Should I use the terminology left/right click?

When instructing users which mouse button to click an element with, it standard practice to use the phrase 'left/right click': To download the file, 'right click' the link and choose 'Save Target ...
3
votes
3answers
69 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 ...
2
votes
2answers
146 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 ...
2
votes
2answers
130 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 ...
7
votes
4answers
1k 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 ...
0
votes
3answers
76 views

Who/how/when is content handles in a (less than ideal) UX workflow?

In the several corporate UX settings I've been a part of, once consistent pain-point is content. A bit reason for that is that rarely do I see dedicated technical and copy writers on staff who are ...
2
votes
3answers
102 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 ...
-4
votes
2answers
61 views

What's the best program (that you have used) to compile a professional windows help file (CHM)? [closed]

I have to make a help documentation in windows help file format. The amount of time I have got for this is ~ 5 hours and I have got about 50 pages (slides) that need to be added to this document. So ...
1
vote
2answers
91 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 ...
3
votes
3answers
128 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 ...
5
votes
3answers
465 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 ...
36
votes
6answers
2k 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 ...
3
votes
2answers
100 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. ...
17
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 ...
7
votes
3answers
492 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 ...
8
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 ...
4
votes
3answers
489 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 ...
13
votes
5answers
3k 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, ...
8
votes
3answers
506 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?
0
votes
1answer
399 views

Is there a justification document for UI design from Apple or Microsoft?

In my bachelor thesis (B.A., media science) I am comparing the user interfaces of iOS 5.1.1 and Windows Phone 7.5. I'm focussing on their use of "real world" things. While I know of their guidelines ...
1
vote
5answers
274 views

What is best for sharing “Corporate Application Design and UX Guidelines”? A Printout, a pdf on or a website?

For a long-term project, I'm working on part of the ux- and design guidelines for a corporate application. Till last year they use a 'static' pdf on a fileserver where it gets outdated and nobody is ...
10
votes
1answer
423 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 ...
1
vote
1answer
221 views

What is the standard of validating business requirements?

When a vendor is designing a website for a client - an organisation with Business Analysts and Project Managers assigned to the project - we need to provide concepts/wireframes and with annotations, ...
-1
votes
1answer
43 views

Need a exact naming for the Doc [closed]

I'm working on User Interface Document for a client project. It's actually a mobile project. I need to give a document to the client which include all the finalized User Interfaces (only the final ...
-1
votes
1answer
100 views

explaining/documenting an intricate mechanism

I'm torn between two worlds, I have this very intuitive (but intricate) mechanism in a command line tool, and I'm wondering as to what extent I should explain this. I can go the simple way, not ...
6
votes
2answers
1k 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 ...
-2
votes
1answer
262 views

What do you do after paper prototyping? [closed]

Lot's of us - UX people. Love to start their work on paper. Either sketching or using sticky notes. What's the next step for you? I usually redraw whole paper prototype in Axure. Making the same thing ...