User assistance and accessibility

As an Information Developer, I often ask myself what our biggest fear is. In my opinion, that’s the fear to create useless technical content that no one reads, miscommunicate information, or fail to assist your readers when they need help the most. This fear may come true when we don’t analyze deep enough who our readers are, their needs, and how they access our content.

In this article, I would like to have a closer look at how writers create accessible content and a multisensory experience for readers with disabilities.

Continue reading

Advertisements

Documenting APIs: Open-Source Tools Review

Have you ever been assigned a task to write API documentation, and then you got lost in tools for creating it?

If yes, I would like to share with you amazing research by Diána Lakatos who analyzed loads of info to provide us with a magnificent overview of open-source tools for documenting APIs.

Continue reading

User experience in restaurants or keep your users in mind even at leisure time

Believe it or not, but an InfoDev at work is an InfoDev for life. As Information Developers, we perceive the world from the users’ perspective always questioning ourselves: “Is it clear enough? Can a procedure be shorter? Will that be understood globally?”
Sometimes, before you know it, you find yourself evaluating the user assistance in a 5-star hotel, scrutinizing an airport sign or a restaurant menu, and hunting for the ambiguous, the ineffective, and the incomprehensible with the noble intent to make a user experience smoother.

In this article, I will share my experience of reading the icons in a menu at one of the restaurants.

Continue reading

UX copywriting series. Dropbox feature descriptions

No matter what you’re writing—whether it’s a small tooltip or a long web article—you need to thoroughly check your writing before you publish it.

Good writing is not just about spelling, punctuation, and capitalization, though we definitely need to keep them in mind at all times, among like… a million other things.

During UI text review, InfoDevs point out things that non-professional writers would never think to think about. Today, I’d like to talk about the most typical things that we stumble upon during the UI text review.

2018-12-18_15-29-19

Brace yourselves – it’s going to be a long article but a 100% practical one and so worth a read! We’re going to discuss 6 reasons why Dropbox feature descriptions did not pass our UI text review.
2018-12-18_15-42-59
Continue reading

Linear User Guide: Is It any Good?

Many believe that written user guides are doomed to extinction. Although their usage has diminished slightly, they are not clean gone yet. They are still with us—serving their particular audience and making us wonder what is the best approach to structuring them.

With the rise in the popularity of online documentation, many have ditched linearity and adopted a topic-based approach to writing—faster, more convenient, and definitely more efficient from the user perspective; absolutely challenging from the author perspective. But is such an approach still any good for structuring user guides which, unlike help systems, don’t provide immediate assistance to the user, differ in the very context of use, and are designed with a clear intention—to teach and guide?

Continue reading

Diagram Series: Troubleshooting

If you read my previous articles from the Diagram Series, you are already familiar with the process of creating diagrams, the role of text in diagrams, practical tips, and so on. Now let’s see how to troubleshoot issues that accompany you from the first drawing and to the final approved diagram.

The most informed people to create diagrams are SMEs, yet they are the least appropriate for this role.

Continue reading