smiths / aorta

Other
2 stars 0 forks source link

Assurance Case GA #55

Closed JovieL25 closed 1 year ago

JovieL25 commented 1 year ago

Hello Dr. @smiths,

After our discussion of adding a warning message in 3D Slicer, I found that I am able to put any message under Help & Acknowledgement tab.

image

The user will need to click on the AortaGeomRecon module first, then click on the Help & Acknowledgment tab to see these messages. I can make a pop-up message to warn the user and also tell the user that the warning message is available under Help & Acknowledgment at all times.

smiths commented 1 year ago

If it isn't too much extra work, I like the idea of the pop-up message. The message under Help is also good, but that is a passive way to get the message across. A pop-up message that appears once on loading would be great. :smile:

JovieL25 commented 1 year ago

Hello Dr. @smiths,

If it isn't too much extra work, I like the idea of the pop-up message. The message under Help is also good, but that is a passive way to get the message across. A pop-up message that appears once on loading would be great. 😄

I found from the Slicer forum, it seems that a custom dialog is not a good option

In most workflows, popup windows are unnecessary and they are very annoying for the users. Instead of popups, you can follow standard Slicer style and use Qt designer to create your module GUI (https://www.slicer.org/wiki/Documentation/Nightly/Training#PerkLab.27s_Slicer_bootcamp_training_materials 51)

Instead, I can make another phase such that when the user clicks on the AortaGeomRecon module, the warning message appears on the module UI, and the user must click on confirm button to continue.

image

This warning phase will show once each time the user opens the AortaGeomRecon module, even working on an existing patient.

What other warning message should I include here?

smiths commented 1 year ago

Great thought process @JovieL25. You should definitely do as you describe and you should be sure to write up your rationale in your report.

The warning message should state that only qualified persons that have reviewed the user instructions should use the software. We might think of additional warning statements as you proceed.

JovieL25 commented 1 year ago

Hello Dr. @smiths,

I have copied the user instructions content to the design document website, which is publicly available to the users (I assume the user might not look at the source code). The text box cannot redirect website, so I have to paste the website URLs. Redirect works when the user clicks from the Help tab.

image

The design documentation website now has a user instruction section.

This is what it looks like under the Help tab.

image
JovieL25 commented 1 year ago

Hello Dr. @smiths,

I have modified the assurance case GA to match the AortaGeomRecon case.

image

I changed GA2.3 and EGA4, let me know if Assurance Case GA is good to merge with the main branch.

I remembered that you want me to add context for Module Guide and Design Document, are the contexts adding to GI?

smiths commented 1 year ago

@JovieL25 the AC above looks good to me. Yes, you should merge it with the main branch. If we have time, we can add context bubbles to the ACs (like bubbles defining the documents module guide, test plan, test report, etc.). This isn't a priority though. We can add this information later. it is also fine if we don't get to it before you are done.