Technical Writing Blog

There is a preconception about technical writing that limits its capabilities to instructional and training material solely. In reality, though, that is just one of the many layers. Yes, software documentation and user guides help convey a technical writer’s ideas to an audience, but they also make way to interesting marketing opportunities. Think about it…

It seems capitalization is becoming sort of a problem. If you take a look at multiple websites, you’ll see the same word capitalized in different ways. I mean, is it Microsoft or MicroSoft? Or do we just write microsoft and call it a day? Some user guides capitalize each word within a title, some leave…

It’s time to accept the facts: you can’t do it all by yourself. As skilled and task-oriented as you may be, juggling multiple projects at once can take a toll on you. You need to let others help you and take some of the pressure off your shoulders. However, delegating tasks isn’t as simple as…

Some people like to write creative content or poetries. Others like to explain to people how products or software works. If you are particularly talented when it comes to breaking down complex processes into easy-to-understand articles, then technical writing might be the right niche for you. Technical writing refers to the process of creating the…

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…