User documentation that includes different types of graphics is more effective and easier to perceive than monotonous text. A diagram is just one type of graphics that prevails mostly in technical documentation. When creating diagrams on a daily basis, you eventually learn to overcome such difficulties as: vague explanations, inaccurate SMEs’ drawings, abundance of details, or lack of information. As an Information Developer, you must know how to combine these diverse chunks to create consistent graphics in user documentation. In this article, I will discuss some tips on decrypting SME’s drawings to make the process of creating diagrams an interesting and creative experience.
Creating a diagram may be a total curse or the most interesting and creative experience on the project. It all depends on information complexity, the time needed, and your drawing skills. In this article, I will explain the steps how to create a diagram from scratch.
When creating diagrams, keep in mind that they should be easy to scan, understand, and interpret. This post provides practical tips on how to make your diagrams informative, visually appealing, and easy to comprehend.
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
For decades, the concept of user personas has been associated with marketing, advertising, user-centered design, and business analysis. Nowadays, personas are winning the deserved attention of Information Developers worldwide.
Usually, the creation of user personas is initiated by UI/UX designers or business analysts. But what if you do not have any in your team? In my project, I created user personas myself and was surprised how it changed the quality of my content.
Deep understanding of readers is fundamental to creating qualitative and effective content.
In this article, I am going to review and consider user personas from the perspective of an Information Developer.
In the previous article “Navigation Links: Introduction”, we discussed typical mistakes that Information Developers make when creating navigation links and established some guidelines on how to use navigation links correctly to make the content more concise, accurate, and scannable for users.
In this article, we are going to discuss the most common types of navigation links, their usage, as well as tips and tricks on how to use them correctly.
One might think: “How difficult can it be to use navigation links in technical documentation? I know where they are in my application, so I just use them.” Well, you’ll be surprised at how easy it is to screw things up with navigation links and make your readers frustrated and helpless. This article will explain what a navigation link is, its purpose, correct usage, and much more.