text, usually about how to use a program.

learn more… | top users | synonyms

1
vote
4answers
124 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
123 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 ...
5
votes
3answers
168 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 ...
16
votes
1answer
779 views

Best practices for UI that introduces new users

I'm working on an onboarding UI to help new users get familiar with a web app and I was thinking about some good ways to implement it. From what I have come across so far, it seems that many ...
0
votes
2answers
49 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 ...
3
votes
1answer
69 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 ...
7
votes
4answers
462 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 ...
24
votes
5answers
764 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
59 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
99 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 ...
5
votes
3answers
265 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 ...
2
votes
2answers
105 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 ...
35
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 ...
0
votes
3answers
63 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 ...
9
votes
4answers
267 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?
2
votes
3answers
76 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
52 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 ...
17
votes
4answers
1k 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 ...
1
vote
2answers
80 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
116 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 ...
22
votes
8answers
785 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 ...
3
votes
2answers
93 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. ...
11
votes
3answers
306 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 ...
8
votes
4answers
763 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 ...
5
votes
1answer
878 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 ...
1
vote
5answers
252 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 ...
0
votes
1answer
363 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 ...
-2
votes
1answer
243 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 ...
6
votes
2answers
863 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
361 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 ...
12
votes
5answers
2k 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, ...
4
votes
3answers
367 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 ...
2
votes
3answers
147 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.
8
votes
3answers
387 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?
10
votes
1answer
361 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
202 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, ...
7
votes
4answers
323 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 ...
-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
91 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 ...
0
votes
1answer
912 views

What should be covered in a UI Standards document?

I'm a coop student who is creating a web/desktop application design standards document for a company I'm working at. Each standard in the document needs to be supported by a reputable source. What ...
6
votes
3answers
1k 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 ...
2
votes
3answers
253 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
1answer
66 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 ...
8
votes
5answers
2k 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 ...
7
votes
1answer
180 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 ...
11
votes
2answers
17k 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.
4
votes
3answers
179 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 ...
8
votes
2answers
287 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 ...