How to write good user manuals

In this context, technical documentation relates to instructions, operator manuals, procedures and other information created for installing, using and maintaining more or less technically complicated products. Technical writers or authors typically produce professional technical documentation, but many different job titles can be found.

This website is an ongoing project. Many texts are still missing under each topic. Only selected texts are translated to English. Please have patience.

Content and structure

Under this topic, you will find texts dealing with what information your user manuals can and should contain.

Writing

It is all about writing briefly, simply and comprehensibly. And it takes work!

Methodology

How should I work to write user manuals most cost-effectively?

Publishing

There is no point in writing good user manuals if the customer cannot access them.

Layout

Regardless of the type of user manual you write, the information must be presented visually.

Pictures and illustrations

Graphic representations in photographs, illustrations and other multimodal texts play an important role in user manuals.

DITA publishing

Many people bang their heads against the wall using traditional office tools to write technical documentation. Not least, this applies when the documents become large and complicated. DITA may be a solution.

Tools

Good tools are half the job. Being able to work effectively with the right tools is incredibly important.

Relevant academic theory

This is what it's really about: your and my ability to convey information.

All external links open in a new window. I take no responsibility for information on external websites, even if I have linked to them. Please report links that do not work.

The information on this page represents my personal opinions and my understanding of the topic being described. Feel free to link to the page, but do not copy large parts of the content without permission. I take no responsibility for any errors, misunderstandings or missing information. I also take no responsibility for any mistakes you may make or cause as a result of incorrect or missing information. You are welcome to contribute with comments, relevant experiences or additional information. See Editor and contact information.

This website - "Written information" - is created for you who, in one way or another, work with user manuals and technical documentation. How do you write good user manuals?