User Guide | 2019.2

Editing requirement document details

Edit requirement document details to add additional information or make changes based on review comments or changes to related items.

The following information applies to editing document information. If you want to change the requirements included in a document, open the document. See Modifying requirement documents.

Tip:  If you need to update field values for multiple documents, use bulk field changes. This allows you to quickly update multiple items simultaneously. See Updating Multiple Items.

1. In the Requirement Documents list window, select the document and click Edit. You can also select the document in an open Specification Document window and choose Edit > Edit.

The Edit Requirement Document dialog box opens.

Note:  Icons may indicate the item is locked or marked as suspect. See About item status indicators.

2. Make any changes to the document name or description.

3. Make any changes to information on the tabs in the dialog box.

Tab Displays: More information
Detail Custom field values used in the project. These are unique fields your team uses to capture additional information. Adding requirement documents
Workflow Work performed on the document as it moves through the workflow. Viewing workflow event history
Snapshots Historical versions of the document captured at project milestones or specific points in time. Snapshots are used to compare document versions and view differences between them. Viewing requirement document snapshots
Links Items linked to the document. You can add, edit, delete, and diagram links, mark linked items as suspect to indicate they may be impacted by changes, and clear or investigate suspect dependencies. Working with item links
Files Files attached to the document, including files attached from source control applications, such as Surround SCM. Viewing and downloading file attachments and Viewing local copies of source files
Email Email sent about the document. You can reply to email. Available only if email tracking is enabled for the project. Viewing email and Replying to email
Folders Folders the document is included in. You can add the document to other folders, move it to different folders, or remove it from folders. You cannot add or move the document to public folders you do not have permission to modify or are locked, or locked private folders. You cannot remove the document from locked folders. Organizing Items with Folders
History Historical information about the document, such as when it was created, when it was last modified, and all actions performed on it. Viewing Item History

4. Click Open Specification Document to open the document in the Specification Document window and work with requirements in it. See Working with requirement documents.

5. Click Send Email to email users about the document. See Emailing from Helix ALM.

6. Click Watch to be notified every time the document details change. See Watching issues to be notified about changes.

7. Save the document.

  • Click OK to save and close the document.
  • Click Apply to save and continue working on the document.

Tip:  If the changes impact linked or related items, you may want to mark the items as suspect. This flags the items to indicate they should be reviewed. See Marking items as suspect.