ALM: User Guide

Some project artifacts, such as requirements or test documentation, are presented as documents, that is, as sections linked to each other. Each section is a heading, general information, an atomic requirement, or a test scenario. Sections can be nested, which builds a hierarchy of requirements, test documentation sections, and so on.

New sections are created using:

• the context menu in the Contents;
• the "insert requirement" and "create child" links;
• the green button with a "+" symbol

The "insert requirement" link adds a new section below the current one, at the same level of the hierarchy. The "create child" link creates a nested section (subsection) under the current one.

You can choose how the document is displayed:

• a single section only
• or several sections at once

In the document view settings you can also choose extra information to show in the document tree (contents), for example the UID, the section state, and so on.

To keep these settings for this view, use the standard action: the "save" link that appears in the filter settings field.

Managing edits in a document

While you work on documents, questions and comments on the text come up. Select part of the text to add a comment. Open comments on the document are shown on the additional panel on the right. Click a comment to go to the corresponding section of the document.

The "Comments" filter shows only the document sections that have open comments, or only your comments. This speeds up document review considerably.

Signal that a comment has been addressed (implemented by making a change) or is no longer relevant (if a complete answer was given) with the comment state: completed or open. The comment state is controlled by the checkbox on the comments panel on the right, or by the context menu on the Comments tab of the document section edit form.