Back
to top

Technical Writing Blog

Grow your technical writing expertise with industry news, best practices, articles, product updates

How User Experience Manager Affects User Documentation?

How User Experience Manager Affects User Documentation?

In the field of digital technologies, a user experience manager (UX manager) plays a crucial role in ensuring that products not only meet functional requirements but also provide a seamless and enjoyable experience for users. This extends beyond the product itself into the area of user documentation – a critical touchpoint for users seeking guidance…

Continue reading »
Posted in Documentation UX on 9/25/2024

How to Use Page Analytics to Understand User Behavior?

How to Use Page Analytics to Understand User Behavior?

Understanding user behavior is crucial in this digital information age, where websites are the interface between a business and the customers. Page analytics provide a window into visitors’ journey, revealing engagement levels, preferences, pain points, and areas needing improvement. Now, let us see how these insights can drive actionable strategies to enhance user experience and…

Continue reading »
Posted in Documentation UX on 9/4/2024

Skeleton Illustrations to Improve UX in Technical Documentation

Skeleton Illustrations to Improve UX in Technical Documentation

Envision a user eagerly clicking on a link to access a technical guide for a new software tool they are learning. As the page loads, instead of a skeleton screen that outlines where text and images will soon appear, they are met with a blank canvas or a spinning wheel. This absence can leave the…

Continue reading »
Posted in Documentation UX on 7/3/2024

Engage, Respond, Improve: Maximizing User Interaction with Comments and Feedback

Engage, Respond, Improve: Maximizing User Interaction with Comments and Feedback

Engaging with your audience is more than just sharing information; it’s about fostering conversation and building a community. In the digital age, comments and feedback serve as the lifeblood of user interaction, transforming monologues into dialogues and single narratives into rich, multi-perspective discussions. In this blog post, we’ll delve into the art of encouraging user…

Continue reading »
Posted in Documentation UX on 6/19/2024

Determining the Optimal Level of Detail in Technical Documentation

Determining the Optimal Level of Detail in Technical Documentation

In the course of creating technical content, many writers encounter the challenge of determining how sophisticated or simple their language should be. Though it might seem like an odd question, it is a genuine dilemma. If you choose overly complex language or jargon, the technical documents you create can be difficult for the reader to…

Continue reading »
Posted in Documentation UX on 3/20/2024

Choosing Fonts for Technical Documentation

Choosing Fonts for Technical Documentation

Fonts are an important part of any documentation design be that API documentation, user manuals, case deflection or something else. That is basically the body of the written text. Choosing a font directly influences text perception by readers: its readability and accessibility. Which, in its term, can change the learning curve and product adoption. In…

Continue reading »
Posted in Documentation UX on 2/18/2020

7 Rules for Brilliant UX Documentation

7 Rules for Brilliant UX Documentation

UX as a term is used more often when talking about user interfaces, but it can be applied to any object a human can interact with. Being an important part of the user journey, technical documentation deserves a special mention in terms of UX. Today, we will give you several tips to make your user…

Continue reading »
Posted in Documentation UX on 12/10/2019

Design Tips for Technical Writers

Design Tips for Technical Writers

If you are concerned about your user manuals looking bad, this article will give you certain focus points improving which can turn the situation around. How far you want to take it depends on your subjective opinion regarding this matter. Some people believe that when technical documents look neat, and there are no design elements…

Continue reading »
Posted in Documentation UX on 11/8/2019

What is UX Writing

What is UX Writing

The role of a UX writer emerged not so long ago on the job market, but it has been growing ever since. Major companies like Google are heavily focused on everything UX-related and UX writing as well. UX writing looks like some derivative from technical writing, however, it pursues a different goal. While an average…

Continue reading »
Posted in Documentation UX on 11/23/2018

Page Layout for Printed and Online Documentation

Page Layout for Printed and Online Documentation

Remember, when you studied in college you had to deal with writing different papers? And, if they were not hand written there were all those requirements about the font size, the quotes, the page breaks…’Yuck! But my paper is very much readable the way it is. Do I really have to do this? What a…

Continue reading »
Posted in Documentation UX on 11/9/2017