Designing features

You use the Design page to complete the following tasks:

Finding requirements and tasks that are relevant to the Design subpage

The following procedures describe how to find requirements and action items that are relevant to the Design subpage.

To view requirements associated with the Design subpage:

  1. Click the Projects page.
  2. Click the link for a project that uses a project template.
  3. Click the Design icon on the Page Navigation toolbar or the Design link in the left navigation pane.
  4. In the Requirements column of the activity area, click one of the following.
    Note that the activity area is either directly below the page navigation toolbar or at the top of the page. It is the area with a light blue background:
    Add new - To enter a requirement that may be considered for inclusion in the product.
    View active requirements flagged for discussion - View requirements that have a Flagged for Discussion attribute value that is set to "Yes" and a Status attribute value of Submitted, Started, On hold, or Reopened.
    View active requirements currently in design - To view requirements that have been accepted into the release and for which definition work can start or is in progress. For requirements that appear when you click this link, the value of the Subpage in Lifecycle attribute is Design, and the value of the Accepted into Current Page attribute is Yes. The value of the Status attribute is Submitted, Started, On hold, or Reopened.
    View active requirements ready for design - To view requirements that have been proposed for the release but have not yet officially been accepted. For requirements that appear when you click this link, the value of the Subpage in Lifecycle attribute is Design, and the value of the Accepted into Current Page attribute is No. The value of the Status attribute is Submitted, Started, On hold, or Reopened.
    View active requirements in any stage - These requirements contain Status attributes with one of the following values selected: Submitted, Started, On hold, or Reopened.

To view action items associated with the Design Subpage:

  1. Click the Projects page.
  2. Click the link for a project that uses a project template.
  3. Click the Design icon on the Page Navigation toolbar or the Design link in the left navigation pane.
  4. In the Action Items column of the activity area, click one of the following.
    Note that the activity area is either directly below the page navigation toolbar or at the top of the page. It is the area with a light blue background:
    Add new action item - Click this link to enter an action item, for example, you would click this link to add a reminder to write a use case or review the Marketing Requirements document.
    View active action items that are flagged for discussion - To view action items that have a Flagged for Discussion attribute value that is set to "Yes" and a Status attribute value of Submitted, Started, On hold, or Reopened.
    View active action items that are specific to design - To view action items that have an Action Item Type attribute value of Design, and a Status attribute value of Submitted, Started, On hold, or Reopened.
    View active action items of any type - To view action items that have a Status attribute value of Submitted, Started, On hold, or Reopened.

Adding and modifying requirements and action items on the Design page

In the Design phase of a project, you decide on the implementation strategy and architecture for new features, and indicate features that are ready to be promoted to the Code & Build phase.

During this phase, there may be one or more additional tasks that you need to complete. You can add tasks, for example, reminders to create use cases, and associate them with the Design subpage.

To add a requirement or action item:

  1. Click the Projects page.
  2. Click the link for a project that uses a project template.
  3. Click the Design link on the Page Navigation toolbar or in the left navigation pane.
  4. Click Add new in the activity area, in either the Requirement or Action item column.
    The activity area is either directly below the page navigation toolbar or at the top of the page. It is the area with a light blue background.
  5. Enter the required information for the requirement or task.
  6. If prompted, click Next.
  7. For a requirement, in the Application Lifecycle section, select Definition from the Subpage in Lifecycle drop-down list. (Typically, new requirements should be assigned to the beginning of the lifecycle.)
    For an action item, in the Submission Information section, select Design from the Action Item Type drop-down list.
    This ensures the action item is returned on a query issued from the Design subpage.
  8. If you want the artifact to appear on a milestone query on the Project Management page, select the appropriate milestone from the Target Milestone drop-down list.
  9. Complete any other required information (marked with an asterisk, "*").
  10. Click Save Changes.

To indicate that a requirement has been accepted into the project and design can begin:

  1. Click the Projects page.
  2. Click the link for a project that uses a project template.
  3. Click the Design link on the Page Navigation toolbar or in the left navigation pane.
  4. In the Requirements column in the activity area, click the Ready for Design link.
    The activity area is either directly below the page navigation toolbar or at the top of the page. It is the area with a light blue background.
  5. From the query results page, click the link for the requirement that you want to accept into the project.
  6. Ensure the following settings are applied to this artifact:
    - The value of the Subpage in Lifecycle attribute set to Design.
    - The value of Accepted Into Current Subpage? is set to Yes.
    - The value of the Status attribute set to Submitted, Started, On hold, or Reopened.
  7. Click Save Changes.
    You can now view this artifact by clicking the Currently in Design query link on the Design landing page.

Indicating when a requirement is ready for coding

To promote a requirement to the next stage of the project, you change the value of its Subpage in Lifecycle attribute. This causes the attribute to be returned on the stage-specific query for the Subpage that you select.

To move a requirement from Design to the Code & Build page:

  1. Click the Projects page.
  2. Click the link for a project that uses a project template.
  3. Click the Definition icon in the Page Navigation toolbar or the left navigation pane.
  4. Click the Currently in Design link in the Requirements column of the activity area.
    The activity area is either directly below the page navigation toolbar or at the top of the page. It is the area with a light blue background.
  5. Select the requirement that you want to indicate as being ready for coding.
  6. In the Application Lifecycle section, select Code & Build from the Subpage in Lifecyle drop-down list.
  7. Click Save Changes.

Reading and creating design documentation

You can access project documentation from a Documentation table on the Design page. If you are responsible for authoring design documents, you can download templates for these documents from this page and upload draft or completed documents to this page. You or the project administrator can also add new documentation templates to the list.

If you have a content developer role in the project (or if you have a role with both VersionControl - Commit and VersionControl - Add permissions), you can add information to this page as well as view this page. However, the project administrator may prefer to take requests for additions to this page and be the sole person who actually performs the updates.

The Documentation table on this page contains a View other project documents link. Clicking this link is equivalent to clicking the Documents and files link in the left navigation pane.

Important: If you experience any difficulty uploading documents on this page, ask your project administrator to be sure that two Subversion integrations settings are turned off for the project. The administrator should click the project link on the Projects page, clickEdit project > Tool configuration, then turn off the Message must name artifact and Committer must own artifact settings in the Subversion section of the page.

To view project documentation on the Design page:

  1. Click the Projects page.
  2. Click the link for a project that uses a project template.
  3. Click the Design link on the Page Navigation toolbar or the left navigation pane.
  4. Scroll to the Process Documents table.
  5. Click the link for the document that you want to read.

To download a project document template from the Design page:

  1. Click the Projects page.
  2. Click the link for a project that uses a project template.
  3. Click the Design link on the Page Navigation toolbar or the left navigation pane.
  4. In the Process Documents section, click the View document templates link.
  5. Click the link for the template that you want to edit.
  6. Save this file locally and edit it.

To add or update a project document on the Design page:

  1. Click the Projects page.
  2. Click the link for a project that uses a project template.
  3. Click the Design link on the Page Navigator.
  4. In the Process Documents section, click the Upload document link.
  5. Browse to the document that you want to upload.
  6. Click Save.
    Note that this document is saved in the project's version control repository. If you want to rename or delete this document, you must use your version control client.

Viewing and adding work products

On the Design page, there are links in the Activities area to various work products. The activity area is either directly below the page navigation toolbar or at the top of the page. It is the area with a light blue background.

A project administrator may have replaced the link to the design system with live data. However, if this has not been done, you can configure these links. You can also add design documents at any time.

To upload design documents:

  1. Click the Projects page and click the link for the project where you want to add this documentation.
  2. Click Design on the page navigation toolbar or in the left navigation pane.
  3. In the Work Products column of the activity area, click View design documents.
    Note that the activity area is either directly below the page navigation toolbar or at the top of the page. It is the area with a light blue background.
  4. On the Requirements Documents page, click Upload document.
  5. Browse for the file and click Save.

To configure the work products link to the design system:

  1. If you have not done so already, use Subversion to check out the project template directory.
    For example, you may check out My-Project/trunk/www/cn-project-pages
    Where My-Project is the name of the project you are working on.
  2. Use your version control tool to update the Design top.html snippet.
    For example, using Subversion, this will be in My-Project/trunk/www/cn-project-pages/Stages/Design/snippets/top.html
  3. Open the top.html file in an editor.
  4. In the section for work products, edit the following link:
    <div class="launch_icon"> 
    Launch systems: 
    </div> 
    <!-- onclick="return launch(this.href, 1);" makes the link open in a small new window --> 
    <!-- Use onclick="window.open(this.href); return false;" to make the link open in a normal-sized new window --> 
    <!-- Edit the title to change tool tip -->
    <ul>
    <li><a href="/nonav/cn-project-pages/help/customizing_alm_links.html" 
         onclick="return launch(this.href, 1);" title="Go to a Web-enabled Design application 
         [Note: link may open in new window]" class="helplink">Design system</a></li>
    </ul>

    For example, you might substitute the following:

    <li><a href="http://www.your_url_here.com/" 
    onclick="window.open(this.href); return false;" 
    title="Go to a Web-enabled design application">
    Design system</a></li>
    As shown in the example, you can change onclick="return launch(this.href, 1);" to onclick="window.open(this.href); return false;" to make the link open in a normal-sized browser window instead of the smaller-sized window.
    Remove onclick="return launch(this.href, 1);" if you do not want the link to open a page in a new browser window.
    Remove or edit title="Go to a Web-enabled design application [Note: link may open in new window]" if you do not want text to appear in a tool tip when the user moves the cursor over the link.
    Remove class="helplink" if you do not want the cursor to be a question mark icon for this link.
  5. Submit your changes.

Customizing the Resources links

At the bottom of the Design landing page, you can provide information that points users to any other information that you think is relevant.

To edit the Resource Links table:

  1. If you have not done so already, use Subversion to check out the project template directory.
    For example, you may check out My-Project/trunk/www/cn-project-pages
    Where My-Project is the name of the project you are working on.
  2. Use Subversion to update the Design bottom.html snippet.
    For example, using Subversion, this will be in My-Project/trunk/www/cn-project-pages/Stages/Design/snippets/bottom.html
  3. Open the bottom.html file in an editor.
  4. In the section for resource links, edit a row in the table, such as the following:
    <tr class="a">
    <td>Customizing the ALM Baseline Project template</td>
    <td><a href="http://www.collab.net/training/alm/Customizing_ALM.doc" onclick="window.open(this.href); return false;" title="Note: link may open in new window">http://www.collab.net/training/alm/Customizing_ALM.doc</a></td>
    </tr>

    For example, you can remove onclick="window.open(this.href); return false;" if you do not want the link to open a page in a new browser window.
    Or, you can remove or edit "title="Note: link may open in new window"" if you do not want text to appear in a tool tip when the user positions the cursor over the link.
  5. Alternate between class="a" and class="b" to provide different shades of gray in the table.
  6. Using Subversion, update this file and commit the changes.