Proposal for Test Documentation Template

[niazim3]

Upon discussing the current documentation for testing GlassBR and NoPCM, @samm82, @elwazana, and I believe that the following column headers are significant enough to have in the tables for each testing subfolder:

• Ref : helpful in cross-referencing between tests as necessary
• Test Name : needs to be descriptive; descriptive may mean longer names which may cause an aesthetic appeal problem*
• Test Purpose : most likely will elaborate on what the test name outlines
• Traceability : helps the reader know why a test case is needed
• Input : will be a file name
  • Significant input : only for test cases that are testing invalid inputs or checking constraints

The following headers should be removed:

• Old Filename : now obsolete, as this was a column that was useful when transferring the old test file
  contents into the new testing infrastructure

In question:

• Notes : nothing too significant is being kept under this header at the moment, however in Test Documentation for GlassBR JacquesCarette/Drasil#262 it is mentioned that they will be useful in the future
• Expected outputs : do we want errors that are output? where the correct answer is from (i.e. an equation** of some sort)?
• *Is a table the best way to go if the document needs to be in portrait mode (mentioned in Documenting Test cases and Test values for noPCM #75)? Perhaps a list of some sort with subheadings that are the same as the column headings mentioned above?
• **If we need to include actual equations, will a table of symbols be necessary? Or can it be assumed that the reader has access to the SRS and can look them up themselves?