projectdoc Toolbox

Work Instructions define procedures for processes. Provide the most detailed information here how tasks are to be executed. This includes best practices.

Documentation Type

Work instructions provide very detailed steps to show how a role is supposed to finish a given task.

These documents may provide information on how to automate a set of instructions.

A less detailed view on the operational work to be done is described with procedures which are associated with activities of processes.


The document type work-instruction provides the following properties:


Please note that only information about specific properties is provided here. Common document property used by all document types are documented by Document Properties.

Superordinate Work Instruction

Work instructions may be composed. This is a reference to the superordinate work instruction.

The value is typically automatically provided by the parent document.


Specify the type of this work instruction for categorization.

Use the Work Instruction Type Doctype to define types of work instructions.


List the roles that take part in running this work instruction. This is typical one role.


While the Audience property describes the groups of readers interested in this document, the Roles property describe the roles that actually take part in it.

Typically all roles involved are part of the audience, unless their part is passive.


Link to the procedure or activity this work instruction relates to. In case no such documents exist, the work instruction can be linked to a service, system, process, function, configuration item, or asset.

The types of target may be extended by adding additional doctypes to the Name List Macro.

Since 3.2


This property is available since version 3.2.



Provide a description for the work instruction.

Work Steps

Describe the individual steps of this work instruction to create the goal.

Dependent on the audience of this instruction, the description of the individual steps may be quite detailed, including screenshots.

Since 3.2


This section is available since version 3.2.

Related Work Instructions

List related work instruction that share the same target.

A Display Table Macro adds related work instructions automatically.

Since 3.2


This section is available since version 3.2.

Subordinate Work Instructions

Complex or long work instructions may be broken into several separate work instruction document instances.

As long as the work instruction is not shared by two parent work instructions, these instructions should be added as children to this document. Otherwise put it on the homepage of work instructions.


These are internal notes that are usually not exported and only visible to team members with write access.

But this is not a safe place to store sensible information. It is just a convenience for the reader to not be bothered with notes stored here for the authors for later use. The security level is about suppressing the representation by a CSS style. Therefore consider this as a convenience for the reader, not as a security tool.


The text of notes sections is also indexed.


For a document the references section contains pointers to resources that prove the statements of the document.

Often these proofs are not easily distinguishable from further information. In this case you may want to skip the reference section in favour for the resource list.


For further information please refer to References and Resources.


The resources section provides references to further information to the topic of the document.

This may be information on the internet provided by the resource or information in the team's information systems. Anything the reader of the resource might want to know, may be listed here.


For further information please refer to References and Resources.