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

Questions tagged [document-design]

The tag has no usage guidance.

1
vote
1answer
131 views

How do you describe “gimmicks” or “animation effects” in your Interaction Design? [closed]

First of all, i hope this isn't a too general question, but it's something that i always have a bit of trouble with. How do you describe the effects (or rather gimmicks) in your interaction design. ...
3
votes
4answers
115 views

Documentation: one long page or several short pages

We're working on the design and organization of our documentation. The current structure is something like this: General info on topic specialized sub-topic 1 specialized sub-topic 2 specialized sub-...
3
votes
1answer
91 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 ...
1
vote
1answer
413 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 ...
2
votes
3answers
96 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 ...
1
vote
1answer
98 views

Styles to distinguish heading levels in a document

Can you advise how to distinguish heading styles in a document? I write informal (i.e. for internal use, not published) technical specifications, and they're structured (e.g. with chapters, sections, ...
4
votes
3answers
85 views

What is the best way to manage a combined UX and Functional Spec?

Our organization has been clamoring for a more organized spec-making process. At the moment, we use a combination of UX Specs (created in a wireframing tool and published as PDFs), and Functional ...
4
votes
2answers
715 views

How do you design columns, sections and spacing to force reading direction & usability?

Instead of long, wide single column documents I've started using multiple columns to improve readability (mostly due shorter lines). However, in a document containing multiple columns and sections I'm ...
3
votes
1answer
94 views

How to make code examples accessible in a document?

I'm creating a MS Word document (and will probably convert it to PDF later on) for a visually impaired programming student. I'm following all the guidelines about text semantics, like correctly using ...
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 ...
180
votes
20answers
25k views

How would you have avoided the Miss Universe 2015 mistake?

In case you missed it, over a week ago Steve Harvey incorrectly announced Miss Colombia as winner of the Miss Universe 2015 pageant. He later apologized and corrected himself; Miss Philippines won. ...