Technical Writing Blog

Aloha! One of the perks of being a technical writer is the hypothetical possibility of working remotely. Freelance technical writers are not bound by anything and can create content from any place on Earth. You can work and travel at the same time, how awesome is that? Summer is in its zenith and help authoring…

Video content drives modern marketing. It enables you to show the essential stuff in a matter of seconds. All information is thoroughly picked and composed in such a manner that a prospect doesn’t need to look for things themselves. It is all crispy and clear and packed into one video. Videos can add a lot…

If we look up the word ‘checklist’ in a dictionary, we will find something like ‘a to-do list’. So, the first thing that comes to mind is planning. And, rightfully so, the easiest way to use a checklist in technical writing is for planning purposes. We will talk about that and also show you a…

Let’s talk about reviewing technical documentation. This topic is discussed in the techcomm community a lot since it is the cornerstone of a good help writing workflow. Before analyzing approaches to reviewing, we would like to draw your attention to the fact that having a convenient environment tailored to reviewers’ needs is the first step…

The API industry keeps growing, and many companies require software for technical writing that would allow creating more comprehensive API technical documentation. No doubt, you can create API documentation even in plain text, but would it be readable? Modern techcomm specialists are striving for more efficient and user-friendly docs, so, certain requirements exist that a…

Let’s talk about verbs in technical writing. We are using them basically in every sentence, so it makes sense to look closer at this notion. As we all know, technical documentation is meant to be as precise and clear as possible and this can be achieved through the correct usage of verbs, as well. We…

We get used to certain things to the point where we can’t tell whether they are good or bad. It can be hard to evaluate a help authoring tool you have been using for a while as you have gotten accustomed to its features and know the workarounds for when things go south. We have…

Today, June 14, is the International Blogger Day. Or, is it? Turns out there is no official blogger day, but it seems that in 2004 some people did choose this day to celebrate their passion for blogging! And, for the lack of a better date, we decided to join them, because, you know what? Blogging…

Technical writers are no strangers to user experience struggles. Moreover, there’s a separate position in many companies for so-called UX writers. They focus on communication with clients through written content and creating the best user experience. We also look closely into UX when searching for the perfect software for technical writers. This coin has actually…

Technical writing software needs to be able to address many things. Help authoring processes are complex and unique for every company, so HATs have to be universal. One of the serious issues for help authoring tools is dealing with different languages. This problem doesn’t limit itself to just translation, but we’ll talk about this, too….