Stack Exchange Network

Stack Exchange network consists of 174 Q&A communities including Stack Overflow, the largest, most trusted online community for developers to learn, share their knowledge, and build their careers.

Visit Stack Exchange
Join us in building a kind, collaborative learning community via our updated Code of Conduct.

text, usually about how to use a program.

0
votes
1answer
43 views

Usability or Accessibility

Overview I am writing some UX Guidelines for our organization which is a Software as a Service business. Our organization relies heavily on Presentations, Marking Material, as well as our Software. ...
0
votes
2answers
99 views

How to describe elements/widgets properly?

We are making widgets for a corporate website and I'm trying to figure out the best way to describe them. Something like writing a documentation. There are at least 10 of these, but here is one ...
2
votes
1answer
111 views

Annotating wireframes in sketch - how do you do it? [closed]

I've been using the notebook pro plugin for the past few months, but I'm running into tons of issues. (crashes, random inability to add new comments in larger docs, etc) What are other techniques for ...
0
votes
0answers
20 views

How do you do documentation of validations and system messages?

I am wondering how can I write full documentation of all form validations and system messages on our e-commerce website. I use activity diagrams, but I have some issues with them: keeping them up to ...
1
vote
3answers
112 views

Tech Writing: What to call list columns?

I'm currently re-writing some software documentation for users, and I'm stuck on how to label the columns on this page, which lists files that you've recently exported from the system, with various ...
0
votes
0answers
18 views

How to document animation on user interfaces [duplicate]

i am new to this forum and this is my first question. I was wondering if there is a good template on how to document animation on user interfaces so that developers and other stakeholders understand ...
0
votes
0answers
14 views

Where should the link be? [duplicate]

If you're writing documents (or websites sometimes) you should be familiar with the following sentence: For further information, click here. Or For further information, please view Privacy ...
1
vote
3answers
123 views

Best way to present and document long screens

Currently I am using tools like Word, Powerpoint and Keynote to present concepts and specs to stakeholders. What is the best – or optimal – way to present and document long screens for stakeholders? ...
1
vote
2answers
76 views

Recommended patterns for help cues/hints/documentation

I've been scouring the web, but haven't been finding much with regards to different options on how to present help text and/or documentation. Obviously there's an established pattern of just having a ...
0
votes
0answers
38 views

Documentation: page for every section?

Consider given URLs: https://getbootstrap.com/docs/4.0/components/alerts/ https://getbootstrap.com/docs/4.0/components/alerts/#link-color Here, bootstrap gets advantage of html id attribute. ...
1
vote
1answer
65 views

How do you manage change of language/terminology in a scalable way for documentation (internal communication)

As UX Designers, we change and create words for things in the UI. Sometimes those are labels, sometimes error messages etc. I've found it very difficult to keep documentation - say confluence up to ...
3
votes
1answer
70 views

How often should the same hyperlink appear in a document?

I was reading a blog post today that made me question how often a hyperlink to the same content should appear in a document. In the post, nearly every reference to HDL (with the exception of one ...
1
vote
1answer
242 views

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

We are working on documenting visual design and I wanted to know: what is the main difference between a UI KIT and a styleguide? Is the difference between them that the styleguide includes design ...
1
vote
1answer
64 views

How to design configurable scripts for non-programmers [closed]

I have a python script that allows users to parse addresses when batch-editing a table. The script allows the user to choose whether to return the house number or the street name to the field (by ...
0
votes
0answers
49 views

How to Separate User Documentation and Developer Documentation?

I'm setting up the documentation for a free software project that I'm working on and am thinking about how to structure the documentation. I'm using github for hosting with a github pages site as the ...
2
votes
3answers
110 views

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

I work on UX team designing a massive, technically-complex, operations application. Difficult enough to comprehend that documentation will help many users, even if the UX is as intuitive and easy to ...
2
votes
3answers
91 views

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

I'm writing a step-by-step employee guide for logging into a course management program. I need to demonstrate that one of the steps will differ depending on where the employee is logging in from. To ...
0
votes
1answer
71 views

Documentation in one page or different pages?

What way should the documentation of a site be, all in one page or split into different pages? Since I think it is relevant, this is my project documentation right now, a library for Node.js ...
0
votes
0answers
23 views

How to provide documentation, drivers, and installation videos with equipment?

A company has been using a CD with inline HTML to deliver a few PDF files, some contact information, a piece of opensource software, and the requisite drivers to installers with their purchase. It ...
1
vote
1answer
72 views

UX documentation

How do you refer to "the user" in your wireframe notes and specs? Do you write it as: "I start typing", or "the user starts typing"? What format do you use? Also, does anybody have any examples from ...
0
votes
0answers
66 views

User experience and Agile Modeling

I have a question regarding architect modeling and how an UX designer can use them to deliver better documentation to the developers/software architects. Has anyone used a component diagram to ...
1
vote
1answer
107 views

User manual with screenshots for mobile devices?

I'm thinking of a user manual, which documents a web-site-based application. The manual should introduce and explain the functionality (the various pages) of the application. The purpose of the ...
1
vote
1answer
138 views

Screen shot of all google.com oneboxes

Can anyone provide the URL for an illustration of an exhaustive set of google.com oneboxes? Background: Below is a SERP screen shot highlighting google.com's way of grouping content types, which some ...
1
vote
3answers
70 views

What should I call these navigation buttons?

See image below. These buttons used in an application to move between first, last, next, and previous records. I've seen them referred to as "VCR buttons". As that technology becomes less common (and ...
0
votes
1answer
213 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 ...
3
votes
1answer
45 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 ...
4
votes
2answers
100 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 ...
3
votes
2answers
203 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 ...
6
votes
4answers
438 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 ...
2
votes
2answers
282 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 ...
1
vote
5answers
807 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 ...
1
vote
3answers
357 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 ...
2
votes
1answer
59 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 ...
2
votes
2answers
238 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 ...
0
votes
1answer
70 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 ...
4
votes
3answers
2k 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 ...
4
votes
2answers
801 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/...
6
votes
4answers
162 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 ...
1
vote
2answers
244 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
50 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 ...
1
vote
2answers
80 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, ...
2
votes
1answer
91 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
3answers
233 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 ...
3
votes
4answers
101 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 ...
2
votes
2answers
191 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?
24
votes
7answers
6k 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
560 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. ...
7
votes
4answers
153 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
185 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
47 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 ...