Technical Writing Blog

Technical writing doesn’t come without its fair share of challenges. For an outsider, creating user documentation may seem like a straightforward job: you receive the project details, analyze the task, and then just start writing. But is it that simple? A technical writer is, essentially, a communicator, and their job is to transfer information from…

To jargon, or not to jargon: that is the question. Although technical writing and the word ‘jargon’ appeared long before Shakespeare, this is not exactly the famous question posed by Hamlet. Today it is a tricky matter which occupies the minds of specialists in technical communication and all sorts of writing. But first of all…

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…

Hyphenation is a linguistic phenomenon which is quite often left out of grammar books. Nevertheless, there are rules that one must follow to use hyphens right. Technical writers, for example, need to make their user documentation look professional. Otherwise, their readers might think that the company itself is untrustworthy. Let’s try to figure out how…

If you’ve ever read documentation written by a programmer, it will become clear pretty fast that creating user guides requires a whole different set of skills. Sure, programmers might have the necessary knowledge base, but most of them aren’t very apt in communicating the information in a user-friendly manner. Thus, the user guides they create…

Your documentation team is one busy department. Useful documentation heavily relies on your team’s ability to keep the workflow moving, but in a business where things are notoriously fast-paced, that can be a difficult thing to achieve. With that said, you might find another article interesting, that is – Documentation Team: How to Delegate Tasks….

The numbers paint an accurate picture: visual content rules the digital world. Articles that feature relevant images get about 94% more views than content without graphics. Moreover, the human brain is wired to respond better to visual stimuli than text. In fact, we process images 60,000 times faster than the written word. That’s undoubtedly huge….

You may have seen this job title popping on professional platforms or in your network, only to ask yourself: what exactly does a technical writer do? The intuitive definition of technical writing is that it is a profession that focuses on documenting the knowledge base of products and services and making them easy to understand…

It is hard to imagine now that people will be ever going back to living thier lives without the Internet. Being offline will soon disappear as a concept. The IOT is about to burst, and this will finally settle ‘being online’ as equal to ‘being alive’. Our newspapers, TV shows, family pictures, work…Everything is just…

Becoming part of a documentation team can be a challenge for a writer who is not experienced in this type of work, as it requires a new set of skills and a very specific writing style and approach. Even if you recruit a writer with prior experience in creating documentation and user guides, you still…