Technical Writing Blog

Readability is an obligatory feature for software documentation design. For any user documentation design, really. As you know, it is generally achieved by the font size, shape of letters, and contrast between text and the background. It can be either: dark on light, or light on dark. Both work. But, still, when the time comes…

Some writers dream of creating the next Harry Potter or Catcher in the Rye. Some hope that their plays will be turned into the next Pulp Fiction. And, others find joy in explaining how things work and helping others to perform certain tasks and hope that one day they will create software documentation for a…

The amount of helpful design resources keeps growing. But, still, the quality ones are hard to find without guidance. And, the guidance we offer! In case you are new to design and even creating a color scheme sounds impossible to you, check out our guest blog post, and you will learn that creating a color…

Online documentation authoring is tough. And, it’s not getting any easier without the right tools at hand. Documentation is not a single article covering some topic, but a set of articles united in a single system with the use of structure, content presentation, common look, references, and other means. Do technical writers need some special…

Sometimes, you just open a user manual and know that it is bad. It doesn’t look sloppy, it has a lot of material, the hard work of the documentation team can be seen through the lines. And, it is still bad. How did this happen? This, my friends, is an example of a documentation team…

What is user documentation for a company? We know what it is for end users – a place where they can get acquainted with product functionality, get their questions answered and generally find out more about the product. But what is the value of a user manual for a company? Here are some things documentation…

At the beginning of time, the era of mechanical keyboards started. They were big, heavy, and pretty expensive. And, their clicking sound was deafening like thunder. Then, appeared the Others – the cheap chiclet keyboards. They met in the final battle, and the mechanical keyboards fled the battlefield. Cuz people like things that do not…

Picture this: You love movies, but you hate driving to the theater. You also hate the loud munchers and the chatterboxes who distract you from the plot. Oh, and there’s that one incredibly tall person who always sits in front of you. So, you decided to turn your living room into a home theater. You…

We wanted to start this blog article by explaining the importance of software documentation. But do we really need to do this? Technical documentation is the bridge between you, your customers, and the prosperity of your business. Of course, it is important. There are several ways companies can go to handle their user guides. Some…

Technical writers are specialists who can explain technically sophisticated things in simple terms, understandable for a specific audience. They know how to write and at the same time understand the engineering and technologies. Technical writers often face software errors which were missed by the testers for some reason. That’s why the ability to create a…