blob: 9898be3ea52bd1e72d37ac5e5c78997df57fc097 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<org.eclipse.epf.uma:ContentDescription xmi:version="2.0"
xmlns:xmi="http://www.omg.org/XMI" xmlns:org.eclipse.epf.uma="http://www.eclipse.org/epf/uma/1.0.5/uma.ecore"
xmlns:epf="http://www.eclipse.org/epf" epf:version="1.5.0" xmlns:rmc="http://www.ibm.com/rmc"
rmc:version="7.5.0" xmi:id="-3ur1d5wEMKqeZdPnErf_Ug"
name="detailing_tasks,_DRI2gJklEd2Al9G_gP7uDg" guid="-3ur1d5wEMKqeZdPnErf_Ug"
changeDate="2008-10-13T05:59:20.671-0700" version="1.0.0">
<mainDescription>&lt;p>&#xD;
This guideline provides guidelines for detailing &lt;a class=&quot;elementLink&quot;&#xD;
href=&quot;./../../../core.default.uma_concept.base/guidances/termdefinitions/task_6C1FF051.html&quot;&#xD;
guid=&quot;_x459ktnmEdmO6L4XMImrsA&quot;>task&lt;/a>s. For general detailing guidelines that are common to all method elements, see&#xD;
&lt;a class=&quot;elementLinkWithType&quot;&#xD;
href=&quot;./../../../core.mdev.common.base/guidances/guidelines/detailing_method_elements_general_B2500E20.html&quot;&#xD;
guid=&quot;_jLqqIOFIEdumFeaOJSgmnQ&quot;>Guideline: Detailing Method Elements (General)&lt;/a>.&#xD;
&lt;/p>&#xD;
&lt;p dir=&quot;ltr&quot;>&#xD;
In general, when detailing a tasks (and task steps), provide specific instructions (i.e., prescriptive text). Most text&#xD;
should focus on what needs to be done to accomplish the task (or an individual step of&amp;nbsp;the task). Avoid long&#xD;
descriptions of motivations, reasons, and philosophy. Avoid descriptions that sell the importance of what needs to be&#xD;
done or motivates the steps that need to be performed. Motivations and explanations are placed in guidance such as&#xD;
concepts and supporting materials. Use guidance such as guidelines to provide detailed descriptions of how to perform&#xD;
steps, or to provide steps for alternative circumstances. These motivations can be referenced or linked from the&#xD;
prescriptive text.&#xD;
&lt;/p>&#xD;
&lt;p dir=&quot;ltr&quot;>&#xD;
&lt;font size=&quot;4&quot;>Keep in mind the following guidelines when completing each of the&amp;nbsp;task&lt;/font>-specific text fields&#xD;
(for guidelines regarding the common fields, see &lt;a class=&quot;elementLinkWithType&quot;&#xD;
href=&quot;./../../../core.mdev.common.base/guidances/guidelines/detailing_common_method_element_fields_940D3CE0.html&quot;&#xD;
guid=&quot;_zVLrkJZwEd2ireJkqESkdQ&quot;>Guideline: Detailing Common Method Element Fields&lt;/a>):&amp;nbsp;&#xD;
&lt;/p>&#xD;
&lt;ul dir=&quot;ltr&quot;>&#xD;
&lt;li>&#xD;
&lt;div>&#xD;
&lt;strong>Purpose:&lt;/strong>&amp;nbsp; The Purpose field describes the reason for the method element.&amp;nbsp; For&#xD;
example, for a task:&amp;nbsp;&amp;nbsp;&#xD;
&lt;/div>&#xD;
&lt;ul>&#xD;
&lt;li>&#xD;
&lt;div style=&quot;MARGIN-RIGHT: 0px&quot;>&#xD;
Why is the task being performed?&#xD;
&lt;/div>&#xD;
&lt;/li>&#xD;
&lt;li>&#xD;
&lt;div style=&quot;MARGIN-RIGHT: 0px&quot;>&#xD;
When a task is defined to get a work product to a particular state, identifying the purpose of the work&#xD;
product state may help to clarify why the task has been broken down as it has.&#xD;
&lt;/div>&#xD;
&lt;/li>&#xD;
&lt;li>&#xD;
&lt;div style=&quot;MARGIN-RIGHT: 0px&quot;>&#xD;
What is the goal of the task?&lt;br />&#xD;
&amp;nbsp;&amp;nbsp;&amp;nbsp;&#xD;
&lt;/div>&#xD;
&lt;/li>&#xD;
&lt;/ul>&#xD;
&lt;/li>&#xD;
&lt;li>&#xD;
&lt;div style=&quot;MARGIN-RIGHT: 0px&quot;>&#xD;
&lt;strong>Main description:&lt;/strong> This &lt;span&#xD;
style=&quot;FONT-SIZE: 10pt; FONT-FAMILY: Arial; mso-fareast-font-family: 'Times New Roman'; mso-bidi-font-family: 'Times New Roman'; mso-ansi-language: EN-US; mso-fareast-language: EN-US; mso-bidi-language: AR-SA&quot;>&lt;span&#xD;
style=&quot;mso-spacerun: yes&quot;>field is optional for tasks&amp;nbsp;if individual steps are being used.&amp;nbsp;I&lt;/span>f&#xD;
individual steps are not being used, the Main description should explain the execution of the task and&#xD;
m&lt;/span>ention the input and output work products. Do not repeat text already stated in other fields, such as&#xD;
the Brief description or the Purpose.&amp;nbsp;The task details can&amp;nbsp;be described&amp;nbsp;using the Main&#xD;
description or&amp;nbsp;by including specific Steps.&amp;nbsp;Guidance can be attached to provide further details about&#xD;
how to perform the task.&lt;br />&#xD;
&amp;nbsp;&amp;nbsp;&amp;nbsp;&#xD;
&lt;/div>&#xD;
&lt;/li>&#xD;
&lt;li>&#xD;
&lt;div style=&quot;MARGIN-RIGHT: 0px&quot;>&#xD;
&lt;strong>Key Considerations&lt;/strong>:&amp;nbsp; This field is optional for tasks.&amp;nbsp;It contains useful material&#xD;
that does not easily fit into any of the other sections, such as advice and guidance of a critical nature, as&#xD;
well as warnings, cautions, pitfalls and dangers.&lt;br />&#xD;
&amp;nbsp;&amp;nbsp;&amp;nbsp;&#xD;
&lt;/div>&#xD;
&lt;/li>&#xD;
&lt;li>&#xD;
&lt;div style=&quot;MARGIN-RIGHT: 0px&quot;>&#xD;
&lt;strong>Alternatives:&lt;/strong>&amp;nbsp; This field describes different ways to accomplish the task that could be&#xD;
chosen.&amp;nbsp;This field is not really used any more.&amp;nbsp;It is recommended that you leave it blank.&lt;br />&#xD;
&amp;nbsp;&amp;nbsp;&amp;nbsp;&#xD;
&lt;/div>&#xD;
&lt;/li>&#xD;
&lt;li>&#xD;
&lt;div style=&quot;MARGIN-RIGHT: 0px&quot;>&#xD;
&lt;strong>Steps:&lt;/strong>&amp;nbsp; Steps can be specified to provide a more detailed set of instructions for the&#xD;
practitioner&amp;nbsp;on to how to complete the task.&amp;nbsp;Tasks can be defined by providing:&#xD;
&lt;/div>&#xD;
&lt;ul>&#xD;
&lt;li>&#xD;
&lt;div>&#xD;
A&amp;nbsp;Main description and no Steps&#xD;
&lt;/div>&#xD;
&lt;/li>&#xD;
&lt;li>&#xD;
&lt;div>&#xD;
Steps and no Main description&#xD;
&lt;/div>&#xD;
&lt;/li>&#xD;
&lt;li>&#xD;
&lt;div>&#xD;
A&amp;nbsp;summary or overview of the steps in the Main description, along with specific Steps.&#xD;
&lt;/div>&#xD;
&lt;/li>&#xD;
&lt;/ul>&#xD;
&lt;/li>&#xD;
&lt;/ul>&#xD;
&lt;blockquote dir=&quot;ltr&quot; style=&quot;MARGIN-RIGHT: 0px&quot;>&#xD;
&lt;p>&#xD;
A Step is described using:&#xD;
&lt;/p>&#xD;
&lt;div dir=&quot;ltr&quot; style=&quot;MARGIN-LEFT: 2em; MARGIN-RIGHT: 0px&quot;>&#xD;
&lt;ul>&#xD;
&lt;li>&#xD;
&lt;strong>Name:&lt;/strong>&amp;nbsp;&amp;nbsp; This is the brief description of the step.&#xD;
&lt;/li>&#xD;
&lt;li>&#xD;
&lt;strong>Description:&lt;/strong>&amp;nbsp; This optional field provides more detail for the specific step.&#xD;
&lt;/li>&#xD;
&lt;/ul>&#xD;
&lt;/div>&#xD;
&lt;/blockquote>&#xD;
&lt;ul dir=&quot;ltr&quot;>&#xD;
&lt;li>&#xD;
&lt;div style=&quot;MARGIN-RIGHT: 0px&quot;>&#xD;
&lt;strong>Guidance&lt;/strong>: Guidance can be associated to a task to provide further details about how to perform&#xD;
the task or a specific task step. For more information on associating guidance, see &lt;a&#xD;
class=&quot;elementLinkWithType&quot;&#xD;
href=&quot;./../../../core.mdev.common.base/guidances/guidelines/defining_method_content_elements_21A491E3.html&quot;&#xD;
guid=&quot;_XQqJkCAmEdy1y5bWsXfCCg&quot;>Guideline: Defining Method Content Elements&lt;/a>.&lt;br />&#xD;
&lt;/div>&#xD;
&lt;/li>&#xD;
&lt;/ul></mainDescription>
</org.eclipse.epf.uma:ContentDescription>