This guideline describes how to define method configurations.  Method configurations may be defined for multiple reasons. Some of the most common reasons are to support the construction of processes (process construction configurations) and to support the publishing of the method (publishable method configurations).

Defining a configuration involves identifying the configuration, naming it and briefly describing it. For information on naming configurations, Guideline: Method Element Naming Conventions. For information on how to write a brief description, see Guideline: Writing Brief Descriptions. It is also important to maintain accurate change histories (Guideline: Maintaining Change Histories and Version Numbers), as well as make sure your trademarks and copyrights are accurate (Guideline: Trademarks and Copyrights).

Defining process construction configurations

Every process must have a default configuration. Thus, some configurations may be defined just to serve as the default configuration for a process, as opposed to being published. 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). 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.

Defining publishable configurations

Defining publishable configurations is where you think about how you might like to see the elements get published. Which plug-ins should be published together? How many different web sites do you need?  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 navigation views that are to be published. For information on defining navigation views, see Guideline: Defining Navigation Views.

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 …”

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. 

In addition, the navigation views that are to be published for the configuration should be specified, as well as any publish options.