| <?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="-YRgyEeV_QsrodfBCb-U-Xg" |
| name="new_guideline,_JGfC0JkxEd2Al9G_gP7uDg" guid="-YRgyEeV_QsrodfBCb-U-Xg" changeDate="2008-11-13T14:25:13.937-0800" |
| version="7.5.0"> |
| <mainDescription><p>
 |
| Every practice includes the following standard guidance elements:
 |
| </p>
 |
| <ul>
 |
| <li>
 |
| How-to-Adopt <a class="elementLink"
 |
| href="./../../../core.default.uma_concept.base/guidances/termdefinitions/roadmap_466C36E0.html"
 |
| guid="_19dWYMaHEduMlb2cQZNTYw">roadmap</a>: describess how to adopt the practice
 |
| </li>
 |
| <li>
 |
| <a class="elementLink"
 |
| href="./../../../core.default.uma_concept.base/guidances/termdefinitions/practice_94B5C550.html"
 |
| guid="_wxYvkMaGEduMlb2cQZNTYw">practice</a>&nbsp;guidance element
 |
| </li>
 |
| </ul>
 |
| <p>
 |
| The following sections provide recommendations on what to include in these elements when detailing the practice.
 |
| </p>
 |
| <h3>
 |
| Detailing the how-to-adopt roadmap
 |
| </h3>
 |
| <p>
 |
| Capture the following in the <strong>Main description</strong> field:
 |
| </p>
 |
| <ul>
 |
| <li>
 |
| <strong>Getting Started</strong> section: Include information on how to get started using the techniques described
 |
| in the practice
 |
| </li>
 |
| <li>
 |
| <strong>Common Pitfalls</strong> section: Describe some common pitfalls when adopting the practice
 |
| </li>
 |
| </ul>
 |
| <h3>
 |
| Detailing the practice guidance element
 |
| </h3>
 |
| <p>
 |
| Provide the following content in each of the element fields:
 |
| </p>
 |
| <ul>
 |
| <li>
 |
| <strong>Brief description</strong>:&nbsp;&nbsp;Include one or two sentences describing what this practice
 |
| covers.<br />
 |
| &nbsp;&nbsp;
 |
| </li>
 |
| <li>
 |
| <strong>Purpose</strong>:&nbsp;Include content that describes the business value of this practice -- what do you
 |
| get when you adopt it? This section is essentially the value proposition for the practice. You may want to describe
 |
| some common problems and how this practice solves those problems.<br />
 |
| &nbsp;&nbsp;
 |
| </li>
 |
| <li>
 |
| <strong>Goals</strong>: This field is not used<br />
 |
| &nbsp;&nbsp;
 |
| </li>
 |
| <li>
 |
| <strong>Background</strong>: This field is not used<br />
 |
| &nbsp;&nbsp;
 |
| </li>
 |
| <li>
 |
| <strong>Main description</strong>: This field is optional.&nbsp;&nbsp;It can be used to elaborate on the practice.
 |
| However, it should be kept brief because this is the first page that users are exposed to, and it is better if that
 |
| page is short so as not to overwhelm them.<br />
 |
| &nbsp;&nbsp;
 |
| </li>
 |
| <li>
 |
| <strong>How to read this practice</strong>: This field is optional.&nbsp; It can include content on the best way to
 |
| read this practice:
 |
| </li>
 |
| </ul>
 |
| <blockquote dir="ltr" style="MARGIN-RIGHT: 0px">
 |
| <p>
 |
| For example: "The best way to read this practice is to first familiarize yourself with its overall structure --
 |
| what it is in it and how it is organized. The best place to start is with the Key Concepts for the practice --
 |
| those concepts that are critical to understand in order to adopt the practice. Once you understand the key
 |
| concepts, you can turn your attention to the Work Products produced by the practice. Then you can review the
 |
| practices Tasks. From the work products and the tasks, you can access applicable guidance -- guidelines and tool
 |
| mentors associated with each task provide details of how to perform the task. Templates and checklists associated
 |
| with the work products guide you in their completion and evaluation. You can also access the guidance provided by
 |
| the practice directly, via the Guidance folder.
 |
| </p>
 |
| </blockquote>
 |
| <ul>
 |
| <li>
 |
| <strong>Levels of adoption</strong>: This field is optional. It can be used to provide information about levels of
 |
| adoption of this practice. For example, you may initially adopt a practice by using a few of the recommended work
 |
| products and over time use the remaining ones.&nbsp;<br />
 |
| &nbsp;&nbsp;
 |
| </li>
 |
| <li>
 |
| <strong>Additional information</strong>: Use this field to provide enablement information for this practice. For
 |
| example: available books, articles, training courses, and so on.<br />
 |
| &nbsp;&nbsp;
 |
| </li>
 |
| <li>
 |
| <strong>References</strong>: These are the associations to all the elements that are considered part of the
 |
| practice.&nbsp; For information on defining these associations, see <a class="elementLinkWithType"
 |
| href="./../../../practice.mdev.auth.practice_auth.base/guidances/guidelines/structuring_practice_F1E2CC6E.html"
 |
| guid="_F2l88JSGEdyCzN0eHC4CLA">Guideline: Structuring a Practice</a>.<br />
 |
| </li>
 |
| </ul></mainDescription> |
| </org.eclipse.epf.uma:ContentDescription> |
