The Documentation View is a feature that enhances your experience when working with requirements in our system. It offers a more flexible and word processor-like approach to managing and interacting with requirements within a Specification, Section, or Folder. This view improves the reading experience and allows you to make selective edits to the fields, making your requirement management more efficient and user-friendly.
This user documentation will guide you through accessing and utilising the Documentation View, outlining its key features and functionality.
This version is released as an MVP version, and further improvements will be added to this feature. If you find this feature interesting and would like to provide suggestions/feedback, please feel free to let us know at email@example.com
The Document View is one of six sections available in the requirements module. Once you are in a folder level or specification level, or section level, you can select the document view to see the requirements.
Note that you will be able to see the specification or section along with the description of those objects in the documentation view. In case you are using the displaying the documentation view on the folder level, all the specificaitons and sections will be shown in the view.
Once you have entered the Documentation View, you will notice a more fluid and word processor-like interface.
The fields available for editing will include:
Title: This field is editable and allows you to make changes to the requirement's title.
Rationale: You can edit the rationale, providing a more detailed explanation or reasoning behind the requirement.
Text: The text field can be edited, enabling you to update the content of the requirement to meet your needs.
To edit the fields, you can click on the rich text fields of title, rationale or text and edit them. Once finished, you can click outside the rich text box(light grey background) to save the changes.
You can use the “$” to refer to the valis within these rich text fields. Also, you can do the formatting such as bold, italics, underline, etc.
The fields that are not available to edit are
Identifier: The identifier is non-editable in this view, serving as a unique identifier for the requirement.
Images: Images attached to the requirement will be visible, allowing you to see them along with the requirement text.
Here’s how it looks like:
This version is released as an MVP version and further improvements will be added to this feature. If you find this feature interesting and would like to provide suggestions/feedback, please feel free to let us know at firstname.lastname@example.org