This guideline provides guidelines for detailing tasks. For general detailing guidelines that are common to all method elements, see
Guideline: Detailing Method Elements (General).
In general, when detailing a tasks (and task steps), provide specific instructions (i.e., prescriptive text). Most text
should focus on what needs to be done to accomplish the task (or an individual step of the task). Avoid long
descriptions of motivations, reasons, and philosophy. Avoid descriptions that sell the importance of what needs to be
done or motivates the steps that need to be performed. Motivations and explanations are placed in guidance such as
concepts and supporting materials. Use guidance such as guidelines to provide detailed descriptions of how to perform
steps, or to provide steps for alternative circumstances. These motivations can be referenced or linked from the
prescriptive text.
Keep in mind the following guidelines when completing each of the task-specific text fields
(for guidelines regarding the common fields, see Guideline: Detailing Common Method Element Fields):
-
Purpose: The Purpose field describes the reason for the method element. For
example, for a task:
-
Why is the task being performed?
-
When a task is defined to get a work product to a particular state, identifying the purpose of the work
product state may help to clarify why the task has been broken down as it has.
-
What is the goal of the task?
-
Main description: This field is optional for tasks if individual steps are being used. If
individual steps are not being used, the Main description should explain the execution of the task and
mention the input and output work products. Do not repeat text already stated in other fields, such as
the Brief description or the Purpose. The task details can be described using the Main
description or by including specific Steps. Guidance can be attached to provide further details about
how to perform the task.
-
Key Considerations: This field is optional for tasks. It contains useful material
that does not easily fit into any of the other sections, such as advice and guidance of a critical nature, as
well as warnings, cautions, pitfalls and dangers.
-
Alternatives: This field describes different ways to accomplish the task that could be
chosen. This field is not really used any more. It is recommended that you leave it blank.
-
Steps: Steps can be specified to provide a more detailed set of instructions for the
practitioner on to how to complete the task. Tasks can be defined by providing:
-
A Main description and no Steps
-
Steps and no Main description
-
A summary or overview of the steps in the Main description, along with specific Steps.
A Step is described using:
-
Name: This is the brief description of the step.
-
Description: This optional field provides more detail for the specific step.
-
Guidance: Guidance can be associated to a task to provide further details about how to perform
the task or a specific task step. For more information on associating guidance, see Guideline: Defining Method Content Elements.
|