Skip to content
GitLab
Next
Closed
Issue created by Nick Brandt@nickbrandtDeveloper0 of 3 checklist items completed0/3 checklist items

Include the ability to add a long description for Requirements in order to provide additional context

As a user, I want to be able to include a long description for a Requirement, so that I can provide additional context surrounding the Requirement as well as have access to a rich text editor for formatting, links and images.

Research Finding: https://dovetailapp.com/projects/311cf999-aa28-4be3-a765-cbaa98c24368/insights/present/0eda9639-bc9f-47a8-a2f8-fcd9004a9a2d

JTBD

When I am creating a Requirement,
I want to be able to include additional details and context regarding the Requirement,
So that others are able to better understand the Requirement and where it originated

When I am creating a Requirement,
I want to be able to include links in the description,
So that I can easily direct others to additional resources

When I am creating a Requirement,
I want to be able to include designs and other images,
So that others have the necessary assets for that Requirement

Development Details

  • Add new DB field description - backend
  • Persist changes to this field - backend
  • Display the description - frontend

Solution

This new description field will not be shown on the list view, but instead available from the slide out drawer which will be worked on in #232705 (closed).

A user can edit the description by either opening the drawer and clicking on the Edit (pencil) icon button, or by clicking on the Edit (pencil) icon button from the list view (which would open the drawer for that item with the Title/Description in edit mode). Designs shown below.

Edited by Nick Brandt