Skip to main content

What’s more important: UX or documentation?

Senior Technical Writer
Apr 08, 2014

This blog post is part of a series about what we’ve learned while developing WalkHub, a community hub that creates a framework for integrated tutorials that guide users through an interface, one step at a time.

By definition, user experience (UX) design incorporates visual design, information architecture, interaction design, and usability to positively impact the overall experience a person has with a particular interactive system and its provider.

It is very important and can be the difference between a failed and a successful project. Documentation is less glamorous and often neglected. If the user experience is designed well enough, why would you need documentation?

The problem with this premise is that the familiarity of a user with an interface is always a function of a user’s previous experience with similar interfaces. As a result UX works best for people with more Internet experience.

When you are developing the user interface of a new product, you’re basically chasing cultural consciousness to make sure users will understand it based on their previous experience. When new functionality comes, you’re trying to play catch-up looking for things that are similar to help your users’ orientation.

Of course, you must do your best to ensure great user experience, like making your online interfaces easy to read by using chunks of text and lists, a comfortable spacing and simple language with the least jargon possible. Follow conventions to help users who have experience with similar systems and test the interface with your target audience. All this doesn’t guarantee though that all users will use the interface as easily and effortlessly as you intended.

Because no matter how hard you try, if a user has no or very little experience with similar online interfaces, he will still be lost.

So when you make your UX so good it doesn’t need any documentation, the question is, for what audience? Are you prepared to ignore part of your customers or do you create backup plans for the people that have a different experience profile?

We found it’s best not to force yourself to choose a side, and take the best from both worlds instead.

Diána is a Senior Technical Writer at Pronovix. She is specialized in API documentation, topic-based authoring, and contextual help solutions. She writes, edits and reviews software documentation, website copy, user documents, and publications. She also enjoys working as a Program Monitor for NHK World TV and Arirang TV. She graduated as a programmer, then went on earning system administrator and system analyst and designer degrees. She's fluent in English and German, and worked as a translator for a publishing company translating books from German to Hungarian. She's the Hungarian translator of Basecamp. Before becoming a writer, she worked with international clients like Sony Pictures Television, Da Vinci Learning and The Walt Disney Company as a key account manager in integrated marketing campaigns focusing on digital media.

Newsletter

Articles on devportals, DX and API docs, event recaps, webinars, and more. Sign up to be up to date with the latest trends and best practices.

 

Subscribe