Technical Writing Blog

Modern businesses love everything seamless. Like, Continuous Integration is a new go-to for software engineers. The underlying principle is sharing code as often as possible, ideally, several times a day. This means new releases become more frequent than ever and other teams need to keep up. For technical writers this means that help topics need…

Reality pushes us towards the biggest dilemma of technical writing once again – writing expertise vs. technical expertise. Many employers decide this based on their subjective thoughts on the matter which is not the best approach. Sometimes, this choice is heavily dependent on company traditions. For example, a company has been always hiring people with…

Do you like/read comic books? If the answer is ‘no’, you might learn a thing or two from this post. Not just about comic books but why so many people find them captivating and what technical writing can borrow from that concept. If you are into comic books, then you already understand their potential in…

A lot is being said about product life cycles. Marketers are paying special attention to them, many business decisions are done based on the stage the product is at. But if you think about it, technical documentation has a life cycle of its own. We can talk about the life cycle of a separate help…

Google Analytics is traditionally an SEO and marketing tool. These departments are known to take advantage of this product daily to track multiple data and come up with conclusions regarding whether their current strategy is any good. Technical writers have their own stats to pay attention to. They are mostly connected with internal stuff, everything…

We love technical writing, and, we like to think about it as something that can make the lives of so many people better and easier. We place readers on a pedestal and keep looking for ways to connect with them, to communicate more effectively. From our standpoint (as creators of a software documentation tool), the…

Since you are visiting our website then you probably know that we create software to help writers. We have years of experience of working with techcomm experts, so we know what is going on in the industry. Being a client-oriented company, we pay a lot of attention to what our users are saying, and, in…

Today, we are going to cover quite an interesting topic that discloses how a technical writer can contribute more to the company’s success and have a stronger presence within the company. For that, let’s take a look at an overlapping role – knowledge management and see where these two positions differ, where they coincide, and…

What’s one of the most important things in a user manual? Its structure! Usability largely depends on how well a technical document is structured. There are certain basic elements that bring logic to your docs. We are going to talk about the best practices of their usage, so, keep reading. TOC A table of contents…

Every member of the techcomm community loves technical writing for one reason or another. Otherwise, why would they stick to this industry, right? Help authoring is quite a special occupation that requires a certain personality type and skill set, we already spoke about in the article on the perfect skills for a technical writer. What…