Document NFRs | docxrunner

TopOfPage

Document the NFRs

Solution Document

Solution Document sections

Test Case sections

Test Case

Test Case Template

Overview

Performance Non-Functional Requirements are an

essential component of performance testing.

They also may vary widely from organisation to

organisation, from project to project, and sometimes

from test to test.

This section allows you to include them in your

documentation for reference by other performance testers

in a team, or for future testers.

They are documented in their own section, plus there is the option to link each Timer to an NFR.

The DoxRunner Process Raw operation adds them to the script as comments, as shown in the illustration on the right, which shows how they are documented in a Timer (top), then how they are documented in an NFR section (middle) and how the comments are formetted in a script (bottom).

Overview

Section Management

Section Management - NFRs

An NFR section is optional, is semi-structured, and cal appear in three places:

Any Test Case;
The Solution document;
The Test Case Template document.

Common Characteristics

Each instance of the NFR section consists of:

a Section Title;
a Bookmark;
free-form Body Text;
a Table with a minimum of three columns (Category, ID, and Description).

The Bookmark:

Mandatory;
Location: Immediately before the Section Title;
Structure: Depends on which document it is embedded in:
- Test Case: P_WT005_NFR (where WT005 is the Test Case ID)
- Test Case Template: P_NFR
- Solution document: V_NFR

The Section Title:

Mandatory;
Location: immediately after the Bookmark;
Structure: Free-format text;
Style: I_Heading n or I_Appendix n, where n can be an integer from 1 to 5;
Length: Cannot be longer than 200 characters.

The Body Text

Optional;
Location: between the Section Title and the Table;
Structure: free-format text;
Style: I_BodyText;
Length: Cannot be longer than 1,000 characters.

The Table:

Mandatory;
Location: immediately below the Body Text (or Section Title if there is no Body Text):
A minimum of two rows:
- A Heading row and a Data row (one data row per rule);
- If there are no rules, the last Data row can contain empty cells (or the section can be deleted);
A minimum of three columns:
- A Category column, an ID column, and a Requirement column;
- More columns can be added;
- All cells in the Category, ID, and Requirement columns must conform to specific rules, as described in the Overview above.

Advice

TestCase

Advice

Assess whether the section is necessary. This decision will need to take into consideration two factors:

Whether documenting NFRs add value to the organisation;
Which scenario you have chosen when assessing the relationship between Test Case sections and Solution document sections.

Assess the Section Title and update it if necessary.

Make sure the table has the three mandatory columns (Category , ID, and Requirement), each with the specified heading text.

Assess the table to see whether more columns are appropriate, especially a Description column.

Assess the Body Text between the Section Title and the Table and update it if necessary.

Make sure its bookmark is visible and located immediately before the first character of the Section Title (see each of the examples further down this page).

Do not change the bookmark.

The section looks better when on a page with portrait orientation.

Test Case Section

The NFR section is optional and can be located anywhere in a test case between the Description sections and the Transaction Timer section.

It is semi-structured. The structure is described above.

It must be referenced by a Bookmark that must be located immediately before the Heading.

The Bookmark must contain the Test Case ID and is structured as follows (where CEP001 is the Test Case ID):

P_CEP001_NFR

If a rule in a Data row of the Table contains a Parameter name that is the same as one in the Solution document, then the one in the test case takes precedence.

TestCaseTempate

Example

Test Case Template Section

The NFR section is optional and can be located anywhere in the Test Case Template between the Description sections and the Transaction Timer section.

It is highly structured. The structure is described above.

It must be referenced by a Bookmark that must be located immediately before the Heading.

The Bookmark is structured as follows:

P_NFR

The Body Text is expected to contain generic text that will be copied to any new test case.

The Table must have a minimum of two rows - a Heading row and a Data row. The Data row is expected to be empty - that is, all cells are expected to be empty. If the Data row contains a rule, then that rule is copied to any new test case.

Example

SolutionDocument

Solution Document Section

The NFR section is optional and can be located anywhere in the Solution document.

NFR rules are normally defined in the NFR section of a test case, however they can also be documented in the Solution document. This is optional. One is included in the original downloaded version of the Solution document and is available unless it was manually deleted after the document was downloaded.

There is only one way to add rules to the NFR section of a Solution document and that is to manually insert them into the table.

If it exists, the section it is semi-Structured. The structure is described above and is identical to the Test Case.

It must be referenced by a Bookmark that must be located immediately before the Section Title.

The Bookmark is structured as follows: V_NFRs

Why would you use the Solution document to document NFR rules? You don't need to, but if there are rules that are common across multiple test cases, then they may be easier to manage if placed in the Solution document instead. In fact, to take an extreme view, you can document -all- NFR rules in the Solution document and define -none- in the Test Cases, if that is easier to manage. The choice is yours.

If a rule in a Data row of the Table contains a rule that is the same as one in a Test Case then the one in the Test Case takes precedence.

AddRule

Example

Add a Rule

An NFR rule can only be added to any of the three documents manually. Make sure the appropriate NFR section exists.

DeleteRule

Delete a Rule

Except for the last rule, deleting one can be done manually in all documents by simply deleting the respective row in the table.

Deleting the last rule can be done in two ways:

Simply clear all cells in the row (do not delete the row);
Delete the entire section.