back

 

Quanos Blog

Our guide for
technical documentation

In a technical editing department, the creation of technical documents is only half the battle. A large part of it is also the organisation of the content: Variant management, terminology, translation management and the automation of tasks are just a few keywords.

Technical Documentation

  • Modularization (9)
  • CCMS (59)
  • Content creation (70)
  • Translation management (11)
  • Smart Information (36)
  • Quality control (34)
  • Documentation (27)
  • Networking service information (14)
  • Trends (9)
  • terminology management (8)
  • Tools and technology (7)
  • AI technology (7)
  • Digitalization (14)
  • Content Delivery (19)
  • Digital Information Twin (15)
  • Product news (2)
  • After sales service (2)
  • Automation (12)
  • Increase efficiency in service (8)
  • Identifying spare parts (2)
  • Spare parts catalogue (1)
  • Variant management (14)
  • Reuse (5)
  • Service portal / Customer portal (2)
  • Layouts and formats (2)

Get your free Q'sletter now!

Regular information about:

  • current webinars and events
  • latest trends
  • valuable download assets

Subscribe now

 

How to Take the New EU Regulations into Account in Technical Writing

With its new directives and regulations, the EU Commission wants to ensure that products are both safer and more sustaina…

 

Creating Operating Instructions – The New Practical Guide Is Here!

Sebastian Schiller, Software Trainer at Quanos, shares his expertise when it comes to creating user-friendly operating in…

 

UX Writing – Important Trend or Unnecessary Fad?

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

 

Harmonized Technical Communication at WEINIG

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

 

Your Style Guide – What Should Not Be Forgotten

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 Documentation in Software Development

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

 

Technical Documentation: The Most Important Standards

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

 

Getting Started with Terminology

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

 

What and Who Benefits from Terminology?

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

 

Reviewing, Editing, or Proofreading?

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

 

How to Write “Single Source”

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

 

Say Goodbye to 1001 Sources - Single Source in Technical Documentation

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

Variants, variants, and more variants  

Variants, variants, and more variants

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

Englische Doku, deutsche Redaktion: (k)ein Problem  

Englische Doku, deutsche Redaktion: (k)ein Problem

This blog article is only available in German.

Safety Information – These Standards Help  

Safety Information – These Standards Help

From risk assessment to warning label  

From risk assessment to warning label

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

Safely to the safety instruction  

Safely to the safety instruction

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

Teamwork times two  

Teamwork times two

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

Guidelines, Style Guide, Editorial Guide  

Guidelines, Style Guide, Editorial Guide

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

Terminology – Made In-House  

Terminology – Made In-House

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

What Makes a Writer a Technical Writer?  

What Makes a Writer a Technical Writer?

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

Pushing the boundaries of technical writing with automation  

Pushing the boundaries of technical writing with automation

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

Automating terminology checks in SCHEMA ST4  

Automating terminology checks in SCHEMA ST4

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

Agile documentation – how development and technical writing complement each other  

Agile documentation – how development and technical writing complement each other

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

How to warn – a skill that has to be learnt - Quanos Content  

How to warn – a skill that has to be learnt - Quanos Content

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

Norms and standards for technical documentation – where to look  

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 i…

Terminology management – a call for clarity and comprehensibility  

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 databas…

Less is more: controlled language for more efficient documentation  

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 sy…

Save real money with workflows  

Save real money with workflows

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

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

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 f…

Achieve optimum text intelligibility in technical writing  

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 …

Simple steps to optimise your documentation for translation  

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 in…

Challenges of software documentation and how to master them  

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 …

Three editors manage 4,000 documents for 100,000 product variants with SCHEMA ST4  

Three editors manage 4,000 documents for 100,000 product variants with SCHEMA ST4

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