Guide to lightweight docs: layout & structuring tips

Reception of your content largely depends on the first impression that it creates for your audience. Within milliseconds of interaction with your document, your users decide whether this is an instruction that is likely to help them work or make their head hurt.

Discover a few simple illustrated tips on how to style your content in a modern and light way!

Continue reading

Advertisements

UI in iOS alerts and dialogs

Why do we perceive some applications as clear, organized, and easy to use? How to phrase UI content in a way that supports the overall style of the development platform? Well, I’ve learned some great points from a fascinating lecture given by Bohdan Hrechanovskyi –– MacPaw UX copywriter. Continue reading

Empathy map: UX practice applied to TechComm

As the IT industry changes introducing new trends and searching to propose more value to a user, technical communication should adapt as well. Technical communicators start searching for better ways to present information and predict all pains to be resolved by the documentation.

One way of doing so is to look for some useful practices outside of technical communication domain. In this article, I would like to briefly introduce a visual practice of empathy mapping that can be adopted into technical communication.

Continue reading

Content Accessibility: Back to Basics

One of the many titles that we documentarians assume is user’s advocate. This means that we defend the user’s interests, cater for their information needs, and provide them with the right content at the right time. But what if some of them cannot read the help topic because the font is too small and light, or they cannot do a step in a procedure as the instructions are too vague? This means that probably, we have overlooked such thing as accessibility. Continue reading

hogwarts houses

User behavior types vs. Hogwarts houses

Earlier this year, I wrote several articles on how to document user personas, Hogwarts style.

Like, there are Gryffindorian how-to steps 1-2-3 good to go pal whoo-hoo you’re done! Or, you can have this very thorough, do-it-at-your-own-pace Hufflepuff tutorials with follow-up tasks that guarantee to put you on your feet. For our Slythery audience, we offer several quick&dirty pro tips, no bull. And yeah, Ravenclaw guys, those appendixes with super-tricky scenarios are for you.

…what a mess of styles, huh? 🙂 Anyhow, choose your house, and I’ll tell you more about what docs you’d enjoy!

https://informaze.wordpress.com/2016/03/02/user-behavior-types-vs-hogwarts-houses-part-1/ https://informaze.wordpress.com/2016/03/16/user-behavior-types-vs-hogwarts-houses-part-2/ https://informaze.wordpress.com/?p=1178&preview=true https://informaze.wordpress.com/2016/04/06/user-behavior-types-vs-hogwarts-houses-ravenclaw/

On the hush-hush side, I would love to write in an individual fun way for each of those houses. But since my invitation to Hogwarts has not arrived (yet!), for now, I am a Technical Communicator for enterprise software.

So, welcome to my world of neutral writing where jokes are not allowed.

Continue reading

All you need to know about user personas (Part II)

In the previous post, we discussed who user personas are and why they are important for Information Developers, considered key elements that should be included into a persona card, and reviewed a user persona sample card.

In this article, I will provide steps on how to create user personas, share some practical tips, discuss how Information Developer can apply user personas, as well as give references for further reading.

“Personas are a way to give the user a seat at the table every time.” Kendra Shimmell

Continue reading