Our guide for
technical documentation

For some time now, the topic of UX writing has been cropping up in technical writing departments time and time again. At …

Numerous products, several services, widely spread markets, and international locations – all these are signs of a succes…

The typical style guide is stored somewhere in a folder on the shelf, or it’s gathering dust in a file directory. The tru…

Agile development processes have been state of the art in the software industry for some years. But what does this actual…

Let us start by saying that you can never tell from the outside which standards will be of relevance to a technical writi…

For some companies, terminology work is an everyday occurrence. They appreciate the benefits of a well-maintained termino…

For many companies, systematic terminology work is still a closed book but it is a task worth taking seriously. After all…

There is a part of the technical writing process that almost every company has a different name for: in addition to revie…

OK, so you obviously know perfectly well how to write “single source”. However, what many people aren't aware of is that …

Single source is a buzz-phrase that we hear time and time again in technical writing. Its meaning seems pretty obvious at…

Most technical writers agree that variants are one of the biggest challenges in technical authoring. But where do these v…

This blog article is only available in German.

Warnings are inevitable elements of operating instructions. At best, inconsistency, incorrect placement, or too much or t…

One of the key functions of instructions is to facilitate the safe use of a product. Clearly, technical writing departmen…

Of the many content modules that make up a manual, warnings are probably the most sensitive. If errors occur here, there …

The review is probably the most underrated phase in the documentation process. On the one hand, the review happens at the…

Editorial Guide, Style Guide, Documentation Guidelines – almost every team of technical writers has one or more documents…

Every technical writer eventually reaches a point where the question of what to call something flips from being a bit of …

“Doesn’t a technical writer just write down what the developer/engineer built?”. You still hear this misconception from t…

Every technical writing department needs input from those that know the subject matter. Often this involves time, effort …

“The support team just called. The latest issues of the maintenance manuals still contain old component names. It’s resul…

Aren’t we looking here at something that is almost an oxymoron? You could be forgiven for thinking so. “Agile” – a word w…

One of the most important objectives of an instruction manual is to ensure that the product is used safely. This comes as…

Technical writers must be able to handle the wide range of tasks involved in creating a document. Not only do operating i…

When it comes to good technical documentation – such as a manual, online help or a knowledge article in a service databas…

The verb “to sanction” can mean “to approve” as well as “to punish”. The Oxford English Thesaurus apparently lists 380 sy…

Authoring work is fun! Optimising and structuring content, modelling content management, refining the layout: this type o…

Authoring processes can be optimised with a content management system, because such a tool provides efficient solutions f…

Imagine that your company produces fan heaters. Winter is slowly approaching and you know that the coming months will be …

If your company wants to market its products abroad, it goes without saying that you’ll need your documents translated in…

Working with software is nothing unusual in this day and age. There are hardly any professions that can manage without a …

Of the 22 technical writers at SEW-EURODRIVE, three editors deliver 4,000 customer-specific instruction manuals for a par…