Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Show test running documentation to testers #394

Open
jscholes opened this issue Dec 16, 2021 · 0 comments
Open

Show test running documentation to testers #394

jscholes opened this issue Dec 16, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@jscholes
Copy link
Contributor

Human testers need certain information in order to run tests successfully and generate usable result data. This includes, but is not limited to:

  • resetting screen reader settings to their defaults;
  • providing screen reader output;
  • executing setup scripts (including when to refresh the test case page);
  • determining what does and does not constitute unexpected output; and
  • only executing the commands as described by each test, and
  • not attempting to trigger screen reader behaviour that will change the result of a test, in any way other than that proscribed by the test.

To ensure that testers are provided with this information and can acknowledge that they've read it, it is proposed that:

  1. The app should display a documentation page, with a button to continue at the bottom, to all new testers as soon as they try to execute a test plan for the first time.
  2. If a tester does not use the provided button to acknowledge that they have read and understood the information, it should be presented again the next time they try to access a test plan as a tester (even if they are an admin opting to test as someone other than their signed in account).
  3. When the underlying documentation is updated, the page should be re-presented automatically to all testers the next time they attempt to execute a test, regardless of whether they have executed tests before or not. All testers will have to re-acknowledge their comprehension of the information.
  4. To assist previous testers in understanding changes to the documentation, a change log section should be included which describes those changes. This can be brief, e.g. by describing the change at a high level, and then linking to the updated section so users can read it in more detail.
  5. The documentation should be easily accessible to all testers wishing to manually consult it, not only presented automatically. For instance, it could be linked to from the App's main nav, and/or the instructions presented for each individual test.
@jscholes jscholes added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant