🥽Defect description

This guide outlines the new feature added to the Defect Panel on the Quality Control (QC) Dashboard – the Description Field. This enhancement is designed to allow you to input and review detailed info

Feature Enhancement: Description Field

  • Purpose: The Description Field enables you to enter additional details for a defect, facilitating better communication and record-keeping.

  • Location: This field is integrated into the defect panel which appears when you select a defect from the list.

Using the Description Field

  1. Accessing the Field:

    • Select a defect from the main dashboard to open the defect panel.

    • The Description Field is located near the top of the panel, clearly labeled for ease of identification.

  2. Entering Information:

    • Click into the Description Field.

    • Type in the relevant details pertaining to the defect.

    • The field is designed to accept text input, providing ample space for comprehensive details.

  3. Reviewing Descriptions:

    • To review the details entered, simply reopen the defect panel.

    • The Description Field will display the previously entered text.

Interaction with Other Features

  • When the status of a defect is updated, a confirmation dialog appears. This feature operates in conjunction with the Description Field, ensuring all changes are intentional and recorded.

  • After entering or updating the description, you must click 'Save' on the confirmation dialog to commit your changes.

Best Practices

  • Provide clear and concise descriptions.

  • Include any relevant information that may assist in the defect resolution process.

The Portal also includes a description feature for added context.

Feature Overview: Description Feature

  • The Description feature is integrated into The Portal to provide additional context for uploaded assets.

  • It is located in a dedicated section beneath the asset preview area, clearly labeled "DESCRIPTION".

Adding a Description

  1. Navigating to the Asset:

    • Select the asset you wish to add a description to within The Portal.

    • The asset's preview should be visible in the central display area.

  2. Accessing the Description Area:

    • Below the asset preview, find the section labeled "DESCRIPTION".

    • This section may contain default text, such as "Confirmation of defect status change".

  3. Entering and Editing Descriptions:

    • Click into the Description box to begin typing.

    • Replace any placeholder or default text with your detailed description of the asset or the context of its use.

Uploading Images and Snapshots

  • To provide further detail or clarity, you can upload additional images related to the asset by clicking the "Upload image" button in the "SNAPSHOTS" section adjacent to the Description area.

Best Practices for Description Entry

  • Be clear and concise, ensuring that the description accurately reflects the asset's details or the status of the item it represents.

  • Use relevant keywords that can assist in searching or categorizing the asset within The Portal.

Last updated