Technical Writing Blog

Technical documentation teams can have different approaches to doing many things. A lot of the stuff can be altered in help authoring, leaving that to personal preference, but when it comes to choosing a place to store user manuals, one needs to be really careful. Today, we will talk about using a CMS for delivering…

The sports industry is rarely named among the top places for tech writers to work. But, actually, there’s a lot of technical communication going on there. Today, let’s take a look at what a technical writer is needed for in the sports industry. User Manuals and Standards for Sports Equipment Technologically speaking, sports equipment can…

Millennials are here. This is how generations work – one minute they are toddlers, the next – your company’s executives. We are talking about practically the whole world and it is hard to believe that people from different cultures and backgrounds could have any resemblance. But with globalization orchestrating our lives there’s not that much…

The ability to work with SMEs efficiently makes a huge difference in technical writing. A lot of things like depth, clarity, and precision of descriptions in user manuals depend on how well you communicate your requests to an SME and how successful you are at interpreting and follow-up questions. Today, we will try to come…

Remember when you had to actually install software on your PC to write technical documentation. That wasn’t entirely terrible, but if you think about it… you had to worry about so many unnecessary things like system requirements, enough free space, security, and many more. Working from home wasn’t such a big thing until recently, but…

Readability is something your readers should not concern themselves about. It is your job, as a technical writer, to make sure that ‘OMG this is so difficult to read’ never crosses their mind. This is not something, however, that can be approached mindlessly and solved just like that. To improve readability, first, you need a…

Agriculture was the key element in the development of our entire civilization. It started thousands of years ago with gathering wild grains and later planting them. A lot of significant inventions were happening around agriculture and that enabled countries to grow and prosper. And up till this day, we feed on the same basic things….

AI is a technology with crazy potential. And, a lot of weird things are happening around it, too – you might have noticed that recently vendors can call anything ‘AI’ just to get their target audience interested. This is why, we would like to begin this post with a definition of AI, as stated by…

The tone of voice is quite a popular idea, especially for big companies. It provides the means to improve communication and connect with clients on a more personal level. Is there a place for the tone of voice in help authoring? We think there is. It is called technical communication after all. Let’s try to…

Many technical writers love techy things and technology. This has a lot to do with the fact that numerous techcomm specialists either already have technical skills or are going to acquire them in the work process. If you love technology and are curious about how things are developed, or even thinking about trying something new,…