Norms and standards for technical documentation – where to look

Technical writers must be able to handle the wide range of tasks involved in creating a document. Not only do operating instructions need to be understandable, they must also be easily accessible, ensure safe use of the product and, ultimately, even look appealing. But where can technical writers look for assistance? Some good starting points... Continue Reading →

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 →

Save real money with workflows

Authoring work is fun! Optimising and structuring content, modelling content management, refining the layout: this type of work is varied and absorbing. However, there are also recurring activities that are associated with many repeated steps, such as checking whether node contents have been changed. Or removing redundant comments, and adding taxonomy values to all nodes of a... Continue Reading →

Take the quiz – Austrian Federal Railways implements gamification solution with SCHEMA ST4

Mr Schauer, would you like to begin by briefly describing your role at Austrian Federal Railways? Gladly. I have worked for Österreichische Bundesbahnen Personenverkehr AG (ÖBB - Austrian Federal Railways) since 1988. In 2004, I moved to our head office in Innsbruck, where I am responsible for knowledge management. My main role is as editor-in-chief... Continue Reading →

Up ↑

%d bloggers like this: