Creating guidance

Guidance provides information about how to perform a role, how to create a work product, how to perform your task, and so on.

Guidance is a general term for additional information related to Role, Task, and Work Product.
  1. Expand the content package in which you want to create your guidance.
  2. Right-click Guidance and select New, then select a guidance type from the menu.
  3. The following guidance types have the same editor that includes a Description tab, a Guidance tab, and a Preview tab:
    • Concept
    • Estimating Considerations
    • Example
    • Guideline
    • Report
    • Reusable Asset
    • Roadmap
    • Supporting Material
    • Template
    • Term Definition
    • Tool Mentor
    • Whitepaper
  4. Use the fields in the editor to specify the guidance details. Start by assigning a unique name to the guidance element along with a presentation name that is used as the external visible name when other elements refer to this element, or when the element is published. Every guidance type has specific content fields in the content editor that are distributed over two or more stacked tabs. Use the content fields to describe your guidance type.
  5. Use the Rich Text Editor to edit or enter the text for any field that has the Rich Text Editor icon rich text editor icon. Click the symbol to access the Rich Text Editor. Click the symbol again to close the Rich Text Editor.
  6. In the Icon section, select a Node icon to be displayed with the guidance in the Library view and Configuration view and in the tree browser in a published Web site. The node icon should be 16 x 16 pixels. You can also select a shape icon to be displayed at the top of the published page for the guidance.
  7. Click the Guidance tab. This part of the editor allows you to add and remove guidance for the element. To add guidance, click Add, select the guidance that you want to add, and click OK. To remove guidance, select it in the Guidance field and then click Remove. When you select a guidance element, the brief description of the guidance is displayed.
  8. Click the Preview tab to view the newly created guidance and save by closing the tab.

It is possible to change the types of some of the guidance types to a limited number of other guidance types. To change a guidance type, in the Description tab under General Information section, click Change Type and select an available new type.

If the type of guidance is a Practice, you can add references to other elements in the References tab. If the guidance is a Template, you can attach multiple files or URLs to the guidance in the Description tab.