Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The LUTF Documentation Block

Now to Let's continue with our documentation discussion and dive into some LUTF details

Each test script should include a documentation block. Not all elements shown here are needed. But the more complete it is the more complete the generated document will be.

Here is a slide on the documentation block. I won't go over them in details now, but you can download the slide deck from the wiki.

Code Block
"""
@PRIMARY: Primary Requirement ID
@PRIMARY_DESC: Textual description of the primary requirement
@SECONDARY: Secondary Requirement IDs if applicable
@DESIGN: Design details
@TESTCASE: Test case description
"""

...

Primary Requirement IDSecondary Requirement IDTest Case  Description



NOTE: each The secondary requirement in a test case should be a primary requirement in another test case. The idea here is that some test cases might touch on more than one requirementfield lists the requirement ids which the test case might touch on.

The csv files can then be imported directly into the Confluence wiki or embedded in a document.