Test Suite overview fold out all testcase descriptions

[olw-medcom]

Hey there!
In the testsuite overview / conformance statement overview page, would it be possible to get the ability to open all the testcases and also to close them all?

Furthermore would it be possible to make the description of each testcase support basic html such as image rendering, bold format etc?

[costas80]

... would it be possible to get the ability to open all the testcases and also to close them all?

Yes, that sounds quite simple to do (and a nice shortcut feature). Added to the backlog.

... would it be possible to make the description of each testcase support basic html such as image rendering, bold format etc?

Well, this the purpose of the test case/suite documentation that opens in a popup, so it seems that this would functionally overlap. The current idea is that an extended text-only summary is provided through the description (which is also included as text in reports), whereas extended rich documentation is handled by the popup. Does this approach not work for you?

[olw-medcom]

Yes, that sounds quite simple to do (and a nice shortcut feature). Added to the backlog.

🎉

it seems that this would functionally overlap

Hm yes I see your point.
The thing is that some of our vendors likes to plan ahead before testers actually start testing, so they are requesting essentially a more detailed overview of what is actually tested (but not too detailed). They would like to make a pdf with the entire overview and possibly print it and take notes for each testcase, here they would like a little more documentation.

Currently we use the popup for detailed instructions for the actual testers, things such as how to run it, how to run it headless in a CI/CD pipeline etc.

So the rich text in the description we would use to target test managers and the rich text in the popup we would use to target testers.

So the name would be high level with almost no details, description would be medium amount of details and the popup would be the nitty gritty details.

Let me know what you think

[costas80]

So the rich text in the description we would use to target test managers and the rich text in the popup we would use to target testers.

Ouf that's a niche distinction. Don't get me wrong - the fact that in your case/community things happen in such an organised way is fantastic. But for many/most projects/communities these roles merge into single people doing the job. Showing different levels of rich documentation and options to add/remove/enable might appear confusing or overengineered in most cases.

But coming back to the core need ...

So the name would be high level with almost no details, description would be medium amount of details and the popup would be the nitty gritty details.

.. and considering ...

They would like to make a pdf with the entire overview and possibly print it and take notes for each testcase, here they would like a little more documentation.

... I'm thinking if we could do this as follows:

• [On our end] We add in the ITB in the popups that display documentation the option to export to PDF. This is more/less already what you have as a preview feature for community admins (for the purpose of ensuring test documentation will show up well in PDF test session reports). Testers can skip this but people that want to work with a PDF version and/or print even on paper can do so.
• [On your end] Extend your documentation to include both types of documentations in two sections, allowing people to focus on what they want. An interesting alternative approach would be to keep documentation at test case level for only extended details for testers, and add the high-level planning information at test suite level. To be honest we usually see more use cases for test case documentation but this could be a very nice use case for documentation at test suite level. You would add here an extended document with sections per test case containing the planning-level info, that users can view and also download as PDF (based on the PDF export feature I mentioned above).

Boom! Problem solved? :D

[olw-medcom]

Hey @costas80, yes I think that would work, the best case scenario would be an export to pdf function which makes one big pdf with all of the documentation for each testcase, but if that is not something that aligns with your wishes then indeed I could see ourselves just making a test suite level documentation that can then be exported as a pdf ^_^

[costas80]

... the best case scenario would be an export to pdf function which makes one big pdf with all of the documentation for each testcase

Love it! Sounds like such a nice feature, and also one that is pretty simple to realise. I would see this at the level of the overall conformance statement as an extra export option that would produce a PDF including:

• The high level information of the specification followed by a listing of test suites/cases with links to their pages..
• All test suite documentation, including for each one the test suite documentation (if present) and the test cases' documentation. Each of these is presented in a separate page.

In case certain test suites or test cases don't have documentation I would still include them stating that they define no documentation (for completeness).

What do you think?

[olw-medcom]

I think that sounds exactly like our need! So that's perfect!