Terminology management – a call for clarity and comprehensibility

When it comes to good technical documentation – such as a manual, online help or a knowledge article in a service database – nothing is left to chance. What should the first chapter of the document be called? What is the maximum sentence length? How are tables for technical data structured? Are the graphics labelled?... Continue Reading →

Less is more: controlled language for more efficient documentation

The verb “to sanction” can mean “to approve” as well as “to punish”. The Oxford English Thesaurus apparently lists 380 synonyms for the word “good”. In Thomas Mann’s original German version of his novel “Joseph and his brothers” is a sentence containing 347 words. Three bits of trivia that hint at the diverse, and sometimes... Continue Reading →

The major advantages of a component content management system in technical writing

Authoring processes can be optimised with a content management system, because such a tool provides efficient solutions for different application areas. Every technical writer benefits from the advantages of working with such a content management system, regardless of the fact that the exact situation will differ from company to company. We have summarised the main... Continue Reading →

Achieve optimum text intelligibility in technical writing

Imagine that your company produces fan heaters. Winter is slowly approaching and you know that the coming months will be the most lucrative for your company’s products. You receive feedback from three retailers about complaints from end customers in just one day, which concern the commissioning of the fan heater as well as how to... Continue Reading →

Simple steps to optimise your documentation for translation

If your company wants to market its products abroad, it goes without saying that you’ll need your documents translated into other languages. Regardless of whether the translations are being completed in-house or outsourced to external agencies, the basic requirements are the same: the translations need to be accurate (to ensure compliance with legislation); they need... Continue Reading →

Challenges of software documentation and how to master them

Working with software is nothing unusual in this day and age. There are hardly any professions that can manage without a multitude of digital assistants for communication, organisation, management, design, configuration, control or monitoring purposes. Although software is a practical tool, expert software in particular requires users to absorb large amounts of information, as they... Continue Reading →

Modern Talking 4.0 – the Internet of Things and intelligent information

I announced it earlier and now the secret is out. So what was the topic of my presentation at the annual conference and what were all those mysterious components? The Internet of Things, of course. That much you knew already. But what has it got to do with intelligent content, exactly? Where is technical documentation... Continue Reading →

Better review processes in technical writing

In technical writing, content naturally does not come out of nowhere. Ideally, it emerges in parallel with the product, thus incorporating functional and developmental changes as quickly as possible. To do this, technical writing needs to depart from the local domain and obtain information from people outside one’s own department, agree with them on what... Continue Reading →

Up ↑

%d bloggers like this: