2021-Q4: User feedback on UX

[stanislaw]

• When editing SDoc text files, it is easy to lose the track of which section the current requirement is part of.

  • There are two ways of solve this: the Web UI that are building helps to navigate the documents more easily, see Web UI Backend #563. Also, it should be possible to implement a Language Server Protocol and make the IDEs be aware of the SDoc syntax. See Enhancement: Language Protocol Server for SDoc text language #577.

• The bar between the TOC and document content has the DOC, TBL, ... buttons which affects having a simple visual and mental link between reading and writing the document and understanding where in the TOC you are. cc @mettta

• It is not possible to select the sections UID, only its title.

• The TOC shows 1.2.3 <REQ-001> while the title shows 1.2.3 <no title>

• Requirements Coverage - hover on the boxes does not work consistently - some of the arrows are highlighted, but some are not.

• It's probably helpful if you don't use whitespace characters in the name of the file.

• "Index" vs "Document tree"

An example of this could be the "to index" button. Which when you're on a child page, it says "To index", but when you click on it, you're not taken to the "index" but to the "document tree".

• Visual difference between free texts and requirements is not clear enough:

When i read the generated document in document more, i find it sometimes a bit easy to miss which part of the document is a requirement and which one is not...

• Why is there a difference between the "trace view" in a document and the requirements coverage page?

• Doc, Table, Trace, Deep-Trace - are confusing because they look like tags.

Also from a usability perspective. When I see this, the way I interpret it is that Sandbox SDoc is an item and the things on the right are "tags" or something. So to open the item, i click "Sandbox SDoc", but this does not open the document, it just selects the text. So maybe having a default view in which you items open might be useful?

• Short vs long versions: DOC TBL TR DTR

Here you call them "doc, table, trace, deep trace", here you call them "DOC TBL TR DTR". And at the top you call them: "document, table, traceability, and deep traceability". So some consistency when using shortened versions, and when you use the full one (and which one you use, trace vs traceability) would help.

[stanislaw]

We have managed to implement all the suggestions with the only exception: #1037. Keeping that only item in a separate ticket and closing this one.