| <?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="-S31tXsLMgO0somndvGEdSA" |
| name="new_guideline,_l77zcIB-EduaS6LQ8n6xUQ" guid="-S31tXsLMgO0somndvGEdSA" changeDate="2008-10-13T10:41:14.875-0700" |
| version="1.0.0"> |
| <mainDescription><p>
 |
| This guideline describes how to define <a class="elementLink"
 |
| href="./../../../core.default.uma_concept.base/guidances/termdefinitions/method_configuration_C2B8FA8A.html"
 |
| guid="__V7pAMaEEduMlb2cQZNTYw">method configuration</a>s.&nbsp; Method configurations&nbsp;may be defined for multiple
 |
| reasons.&nbsp;Some of the most common reasons are to support the <em>construction of processes</em> (process
 |
| construction configurations) and to support the <em>publishing of the method</em> (publishable method configurations).
 |
| </p>
 |
| <p>
 |
| Defining a configuration involves identifying the configuration, naming&nbsp;it and briefly describing it. For
 |
| information on naming configurations, <a class="elementLinkWithType"
 |
| href="./../../../core.mdev.common.base/guidances/guidelines/method_element_naming_conventions_4A4F743B.html"
 |
| guid="_lAphAF5-EduT-Px7fh0LSg">Guideline: Method Element Naming Conventions</a>. For information on how to write a
 |
| brief description, see <a class="elementLinkWithType"
 |
| href="./../../../core.mdev.common.base/guidances/guidelines/writing_brief_descriptions_D01D2F53.html"
 |
| guid="_cJbBkCAhEdy1y5bWsXfCCg">Guideline: Writing Brief Descriptions</a>.&nbsp;It is also important to maintain
 |
| accurate change histories (<a class="elementLinkWithType"
 |
| href="./../../../core.mdev.common.base/guidances/guidelines/maintaining_change_histories_and_version_numbers_B83271.html"
 |
| guid="_k91OkFpBEdutiI3y4Hpy9Q">Guideline: Maintaining Change Histories and Version Numbers</a>), as well as make sure
 |
| your trademarks and copyrights are accurate (<a class="elementLinkWithType"
 |
| href="./../../../core.mdev.common.base/guidances/guidelines/trademarks_and_copyrights_F14EB70C.html"
 |
| guid="_OxsfkH8MEdu_ipWWZJimvQ">Guideline: Trademarks and Copyrights</a>).
 |
| </p>
 |
| <h3>
 |
| Defining process construction configurations
 |
| </h3>
 |
| <p>
 |
| Every process must have a default configuration.&nbsp;Thus, some configurations may be defined just to serve as the
 |
| default configuration for a process, as opposed to being published.&nbsp;Process construction configurations include
 |
| just those plug-ins that contain elements that are needed to construct the process and no more. They do not have
 |
| associated navigation views (they are not intended to be published).&nbsp;When naming and describing construction
 |
| configurations, it is recommended that you include the name of the plug-in containing the processes the configuration
 |
| is the default for in the name of the configuration.
 |
| </p>
 |
| <h3>
 |
| Defining publishable configurations
 |
| </h3>
 |
| <p>
 |
| Defining publishable configurations is where you think about how you might like to see the elements get
 |
| published.&nbsp;Which plug-ins should be published together? How many different web sites do you need?&nbsp; A
 |
| publishable configuration should be defined for each target audience/variant of the method. For example, if you need a
 |
| version of the method that focuses on small projects, provide a small projects configuration. If you need a version of
 |
| the method for more large, complex and formal projects, provide a configuration with more content appropriate to that
 |
| context. When defining configurations that are intended to be published, try to minimize the size and maximize
 |
| effectiveness of the published method. Defining configurations is a key part of method authoring. However, selecting
 |
| the correct set of elements to be included in a configuration can be a difficult and time consuming activity. A few
 |
| well chosen and high quality elements are worth far more to the end user than a plethora of elements that really don't
 |
| address the problem at hand. Publishable configurations identify <a class="elementLink"
 |
| href="./../../../core.mdev.common.base/guidances/termdefinitions/navigation_view_8F89044.html"
 |
| guid="_X_hFIPAjEdyHz_B1XFOUgA">navigation view</a>s that are to be published.&nbsp;For information on defining
 |
| navigation views, see <a class="elementLinkWithType"
 |
| href="./../../../core.mdev.common.base/guidances/guidelines/defining_navigation_views_76A906E.html"
 |
| guid="_67agUEyEEdu4NY1n_hCY0w">Guideline: Defining Navigation Views</a>.
 |
| </p>
 |
| <p>
 |
| When defining a publishable configuration, in the Main description describe the target audience for the configuration
 |
| and any other relevant details about it. This information is not published; it is intended primarily for the users of
 |
| method content to decide if they want to use this configuration. “This configuration …”
 |
| </p>
 |
| <p>
 |
| As with all configurations, an important part of defining a publishable configuration is selecting the plug-ins and/or
 |
| packages that are to be published, as well as specifying those elements that should not be published.&nbsp;
 |
| </p>
 |
| <p>
 |
| In addition, the navigation views that are to be published for the configuration should be specified, as well as any
 |
| publish options.<br />
 |
| </p></mainDescription> |
| </org.eclipse.epf.uma:ContentDescription> |
