Skriftlig InfoWritingHow to write good and effective procedures

Photo by Thom Milkovic on Unspash

How to write good and effective procedures

Most of the products you purchase are for a specific use.

This applies to everything from consumer goods such as light bulbs and toilet paper to technically advanced products such as mobile phones and private cars. The key word is still use, every product will perform one or more tasks for you. In the user manual, each task must be explained with one or more procedures.

When discussing procedures, it's easy to confuse the two terms. A procedure can be an independent publication. A procedure can also be a separate object in a larger publication.

(Photo by Thom Milkovic on Unsplash)

Texts

Summary

About procedures

---

Use an efficient and consistent structure in the document

Give your document a title that describes its purpose

Use the introduction to define the context of your document

---

Use an efficient and consistent structure in your task

Give your task a title that describes its purpose

Use the introduction to define the context of your task

---

Provide the prerequisites in a short and effective way

Balance the amount of conceptual information

Write simple and easy-to-understand steps

If relevant, include the results of the task

Explain what the reader needs to do next

Feel free to use examples and tips

You must always include notes, cautions and warnings related to health, environment and safety

Related texts

Methodology: Task-oriented writing

DITA publishing: DITA Task topic

DITA publishing: DITA Task topic elements

Start pages

Skriftlig Info

Writing


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.