| <?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="-KfBg9rn4AHpkTwnVjEFpKw" |
| name="defining_navigation_views,_67agUEyEEdu4NY1n_hCY0w" guid="-KfBg9rn4AHpkTwnVjEFpKw" |
| changeDate="2008-10-16T10:52:52.438-0700" version="1.0.0"> |
| <mainDescription><p>
 |
| This guideline provides recommendations on how to use custom categories to define <a class="elementLink"
 |
| href="./../../../core.mdev.common.base/guidances/termdefinitions/navigation_view_8F89044.html"
 |
| guid="_X_hFIPAjEdyHz_B1XFOUgA">navigation view</a>s. For general information on custom categories, see <a
 |
| class="elementLinkWithType"
 |
| href="./../../../core.mdev.common.base/guidances/guidelines/categorizing_method_elements_using_custom_cats_F66C3F90.html"
 |
| guid="_V7qwIMjpEdyoXMhaXAJ-6g">Guideline: Categorizing Method Elements Using Custom Categories</a>.
 |
| </p>
 |
| <p>
 |
| Navigation views are defined as custom categories that define the structure and content of the published method. Figure
 |
| 1 provides an example of a custom category that represents a navigation view.&nbsp;The custom category definition is
 |
| shown on the left and its realization in the published&nbsp;Web site is shown on the right.&nbsp;&nbsp;
 |
| </p>
 |
| <table title="Figure 1. Navigation View Custom Category Example" cellspacing="0" cellpadding="2" width="85%"
 |
| summary="Navigation view custom category example" border="1">
 |
| <caption>
 |
| Figure 1. View Custom Category Example
 |
| </caption>
 |
| <tbody>
 |
| <tr>
 |
| <td>
 |
| <img height="458" alt="navigation_view_custom_category_example" src="./resources/nav_view_cc_ex.jpg"
 |
| width="523" />
 |
| </td>
 |
| <td>
 |
| <img height="510" alt="navigation_view_example" src="./resources/nav_view_ex.jpg" width="421" />
 |
| </td>
 |
| </tr>
 |
| </tbody>
 |
| </table><br />
 |
| <p>
 |
| In general, the following are some criteria that affect how you define navigation views for your method:
 |
| </p>
 |
| <ul>
 |
| <li>
 |
| Number of elements: The more elements you have, the more there is a need to organize them for easy navigation
 |
| </li>
 |
| <li>
 |
| Published representation of the method: How do consumers of the method want to navigate the published
 |
| method.&nbsp;Define navigation views to support the desired navigation paths.
 |
| </li>
 |
| </ul>
 |
| <p>
 |
| When defining navigation views, it is important to consider the intended audience and usage model of the
 |
| view,&nbsp;since this will drive the overall organization/hierarchy of the view. For example, will the view be
 |
| organized by element type or by process area?&nbsp;This information can be captured in the description of the custom
 |
| category itself.&nbsp;Such information will be helpful to the person who may may want to consider including the
 |
| navigation view in their configuration for publication.
 |
| </p>
 |
| <p>
 |
| When defining the navigation views, it is a good idea to create a navigation views that represents a natural reading
 |
| sequence.&nbsp;The guideline to the user would be: "Yes, you CAN click on the links within pages, but that's only if
 |
| you want to jump to another location in the website, or do some free exploration. If you want to read the material in
 |
| the recommended order, and make sure you didn't miss anything, then use this navigation view".&nbsp;In such a "natural
 |
| reading sequence" navigation view,&nbsp;&nbsp;each topic should appear only once.&nbsp;The benefits of this approach
 |
| are:
 |
| </p>
 |
| <ul>
 |
| <li>
 |
| You can print the configuration
 |
| </li>
 |
| <li>
 |
| You can can the expanded tree visually for a topic (rather than use the "search")
 |
| </li>
 |
| <li>
 |
| You can look for information by logically figuring out what category it logically belongs to.&nbsp;That way even
 |
| if&nbsp;you&nbsp;don't know the name of a page,&nbsp;you can find it by expanding the appropriate nodes in the
 |
| navigation view.
 |
| </li>
 |
| </ul>
 |
| <p>
 |
| The following are some navigation views that you my want to consider defining for your method:
 |
| </p>
 |
| <ul>
 |
| <li>
 |
| <strong>Welcome</strong> view: Includes a Welcome page, as well as About and What’s New pages.&nbsp;Provides a
 |
| starting point for first time users, no matter what their role.
 |
| </li>
 |
| <li>
 |
| <strong>Getting Started</strong> view: Provides quick access to key concepts, Web site structure&nbsp;and usage
 |
| information for the new user.&nbsp;&nbsp;
 |
| </li>
 |
| <li>
 |
| <strong>Key Elements</strong> view: Provides quick access to the key elements of the method -- processes, roles,
 |
| tasks, work products and processes (it is assumed that guidance is accessible from those
 |
| elements).&nbsp;&nbsp;&nbsp;
 |
| </li>
 |
| <li>
 |
| <strong>Team</strong> view: Provides access to all elements in the configuration, organized by method element type
 |
| and then by category.&nbsp;This views serves as a type of index to all elements in the method.
 |
| </li>
 |
| <li>
 |
| <strong>Role-based</strong> views: Provides access to the elements of most interest to the role .&nbsp;
 |
| </li>
 |
| <li>
 |
| <strong>Process-based</strong> views: Provides access to the elements that support the process.&nbsp;
 |
| </li>
 |
| <li>
 |
| <strong>Organization/Project-based</strong> views: Provides access the the elements of most interest to the
 |
| organization/project.&nbsp;This view&nbsp;connects the abstractness of the method (content elements and guidance)
 |
| with the concreteness of project life (physical work products) and encourages the team to live the process. It is
 |
| minimalist and thus largely artifact-based, but may also include: 
 |
| <ul>
 |
| <li>
 |
| Links to the current version of artifacts
 |
| </li>
 |
| <li>
 |
| Elements of the development case,
 |
| </li>
 |
| <li>
 |
| Selected guidance
 |
| </li>
 |
| <li>
 |
| Project team information
 |
| </li>
 |
| <li>
 |
| Change Request information
 |
| </li>
 |
| <li>
 |
| Discussion forums
 |
| </li>
 |
| </ul>
 |
| </li>
 |
| </ul></mainDescription> |
| </org.eclipse.epf.uma:ContentDescription> |
