Documenting Work Packages and Work Items

Documentation  Documents

On the Documents subtab page, you can do the following:

• Assign Solution Documentation structure elements

  To assign a process, process step, or library element to the work package or work item, choose the Assign Structures icon and assign the relevant structure elements in the Solution Documentation. For more information, see Assigning Solution Documentation Structure Elements.

• Unassign Solution Documentation structure elements

  You can unassign a process, process step, or library element from the work package or work item in the Solution Documentation. For more information, see Unassigning Solution Documentation Structure Elements.

• Move structures in work items

  You can move structures including assigned documents between work items. For more information, see Move Structures Between Work Items.

• Display and change the status of a test step

  You can display and change the status of a test step from a work package, work item, or defect correction. You can also change the test case categorization. For more information, see Change Test Step Status and Categorization.

• Display the documents for the work package or work item

  In the Structures section, select a Solution Documentation structure element assigned to the work package or work item to display the documents stored in this structure element in the Documents table.

• Create or upload documents and store them in an assigned Solution Documentation structure element

  If you have assigned a Solution Documentation structure element (process, process step, or interface) to the work package or work item, you can store a new document for the work package or work item. You have the following options:

  • To create a new document, choose (Create New Document). Specify the document title, select the document type, and choose Create.

    The new document, which is based on the selected document type template, is created and stored in the assigned process structure element.

  • To upload a new document, drag and drop a document file from a local storage to the Documents table. Specify the document type and choose Create. The language of the uploaded document is automatically recognized.

  • You can also upload new versions of documents.

  • On the Attachments tab page, you can attach files, such as image files or document files from a local storage, by using drag and drop. The files on the Attachments tab page are stored only locally in the work package or work item, not in the Solution Documentation.

• Link documents to a work package or work item

  To use a document that is already stored in another structure element, choose (Search Documents). Search and select the document in Solution Documentation and choose Link Documents.

• Assign documents that are already available in the Solution Documentation to the work package or work item or cancel the assignment of the documents

  In the Documents table, you can assign the documents stored in the Solution Documentation to the work package or work item or you can cancel an assignment by using the button in the Assign column.

• Edit documents

  For more information on how to edit documents, see Editing Documents for Work Packages and Work Items.

• Change the document status

  To change the document status, select one or more documents and choose (Change Document Status).

  The document status reflects the processing status of the document, for example, In Progress, Review, or Released. You can prevent further processing of the document by setting the status to Released.

• Maintain and change a document owner or document responsible

  By default, the person who has created or uploaded a document is the document owner.

  To change the document owner or to specify or change a document responsible for a document, display the columns Owner ID and Responsible ID in the Documents table. Then select the document and choose the icon for changing the document owner or responsible (Change Document Owner / Responsible).

• Delete documents

  Once you have deleted a document, it cannot be restored. A dialog warns you therefore if a document is also assigned to another work package or work item. In this case, you have the option to cancel the assignment of the document to the current work package instead of completely deleting the document.

Documentation  Current Status

On the Current Status page, you can check the document KPIs. For more information, see KPI Ratings for Documents in My Work Packages and My Work Items.