Q.wiki templates: Process overview, process description, or work instruction – which one do I choose?

Modified on Mon, 18 May at 12:25 PM

You're looking at a blank page in Q.wiki and asking yourself: Which template actually fits here? This article helps you make the right choice – quickly and without overthinking it.

The three templates at a glance

Process overview

The signpost – shows the big picture

Overview

The process overview is your starting point. It shows how multiple processes or sub-processes relate to each other – without going into detail.

When should I use this template?

  • You want to show an entire process area (e.g. "Produce product") at a glance.
  • New employees should understand which processes exist in the first place.
  • You want to link – from here, readers can drill down into individual processes.
Tip: Process overviews are usually found directly below the process map. The number of buttons visible on the process map corresponds to the number of process overview pages you should create.

Process description

The workflow – explains how something works

Workflow

Here you describe how a process works – step by step, with roles, responsibilities, interfaces, and everything you need for each step (links, forms, etc.). This template answers the What and the Who, but not yet the exact How of every individual action.

When should I use this template?

  • A process needs to be officially documented (e.g. "How does our complaint handling work?").
  • Multiple people or departments are involved and need to collaborate, and you want to see the interfaces.
  • The workflow you're documenting spans a longer period of time.
Tip: The process description is the heart of your documentation. Before creating the page, ask yourself: Does the workflow have interfaces? Are multiple departments or roles involved? And: Does it span a longer period of time? If so, choose the process description template.

Work instruction

The guide – shows exactly how to do it

Step by step

The work instruction goes into detail. It's aimed at someone who needs to know exactly what to do and in what order – concrete, precise, and actionable. No room for interpretation.

When should I use this template?

  • A task should always be carried out in exactly the same way (e.g. machine setup, booking process).
  • There are safety or quality requirements where no step can be missed.
  • The target audience is the people doing the work.
Tip: Ask yourself: "Does exactly one person do this, in one go?" Then the work instruction is the right choice – because this template does not have a "Responsible" column, since there are no interfaces to show.

Quick decision guide – which template fits?

I want to …Template
… show which processes exist in an areaProcess overview
… explain how a process works and who is involvedProcess description
… describe exactly how a task is carried outWork instruction
… show new people where to startProcess overview
… demonstrate a process to auditorsProcess description
… make sure nothing gets forgottenWork instruction

How the templates work together

In a well-structured Q.wiki documentation, all three templates work hand in hand: the overview shows the big picture, the process description explains the workflow, and the work instruction provides the hands-on detail. You don't always need all three – but if you notice that a page is trying to explain too much at once, that's often a sign it should be split up. In that case, you would link from within the process description to the work instruction.

Process overview
The picture
Process description
The workflow
Work instruction
The hands-on detail

Related article

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article