Adding requirement documents

Requirement documents group and organize a set of related requirements. For example, you may want to add a document to group requirements based on functional area, release, or component.

You can add documents before or after you add requirements to a project. If you add a document first, you can add new or existing requirements to it. If you add requirements first, you can add a document when you are ready to organize the requirements and add them to the document.

1. Click Add in the Requirement Documents list.

You can also add a document from any page in Helix ALM, except when working in the Administration area. Click Add Item at the top of the page and choose Add Requirement Document.

To add a document that includes requirements, select the requirements in the Requirements list, click Actions, and choose Create Document.

The Adding Requirement Document page opens.

2. Enter a document Name. You can enter up to 255 characters.

3. On the Detail tab, enter a Description of the document. For example, you may want to explain the document's purpose.

4. In the left pane, enter or select Custom Fields values. The available fields and grouping depends on how Helix ALM is configured for your team. To learn more, see Configuring field layouts.

  • To scroll to a field group, click Scroll to fields and select a field group.
  • To expand a field group, click . To collapse a group, click . To expand all groups, click . To collapse all groups, click .
  • If information is available about a field group, mouse over to display a tooltip.

5. Click the Files tab to attach files to the document. See Attaching files.

6. Click the Folders tab to add the document to a folder. See Adding items to folders.

You will use the Workflow, Snapshots, Traceability, Baselines, and History tabs when viewing or editing documents. See Viewing requirement document details and Editing requirement document details.

7. Perform any additional actions.

  • To move the document through the workflow, click a workflow event button. For example, click Assign to assign it to another team member. Click More to see additional events. See Adding workflow events to items.
  • To perform various actions on the document, click Actions and choose an action.
  • To run a report that includes information about the document, click the Reports button and choose a report. See Running reports.
  • To send email about the document, click the Email button and choose an option. See Emailing from Helix ALM.

8. Save the document.

  • Click Save to add the document to the project and return to the Requirement Documents list.
  • Click Apply to save the document and continue working on it. Save the document when you finish.
  • Click Save and Add Another to add the document to the project and then add another document.
  • Click Cancel to discard any changes.

The available options depend on the Add Multiple Requirement Documents user option set in the Helix ALM Client. See the Helix ALM Client help for information about setting add multiple items options.