Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Document clean process

...

Document Properties Marker
overridefalse


Short DescriptionWork Instructions define procedures for processes. Provide the most detailed information here how tasks are to be executed. This includes best practices. 
Doctypedoctypehide
NameWork Instruction 
IDwork-instruction 
SuiteService Management
SetService Management hide
Parent
Parent Property
parent-doctypetopic
property-nameName
 

Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
 
Documentation Type

Name List
doctypedoctype-type
render-no-hits-as-blanktrue
namesQ4 - System
propertyDocumentation Type

 


Categories

Name List
doctypecategory
render-no-hits-as-blanktrue
names/ Services / Operations
propertyCategories

 
Tags

Tag List

 
Iteration

Iteration
valueproduction

hide
Sort Keyhide


...

Section
titleProperties


Transclusion
documentNote Box referencing common Document Properties
idsBox


Section
titleSuperordinate 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.


Section
titleType

Specify the type of this work instruction for categorization.

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


Section
titleRoles

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

Note Box

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.



Section
titleTarget

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.

Version Box
since3.2

This property is available since version 3.2.




Section
titleSections


Section
titleDescription

Provide a description for the work instruction.


Section
titleWork 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.

Version Box
since3.2

This section is available since version 3.2.



Section
titleRelated Work Instructions

List related work instruction that share the same target.

A Display Table Macro adds related work instructions automatically.

Version Box
since3.2

This section is available since version 3.2.



Section
titleSubordinate 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.


Transclusion
documentDocument Sections
idsstandard-sections-bottom


...