How to write a nlxx file?

Back to User Guide Main Page

---

A nlxx file with more than one XX must be introduced with the stage instruction "Behaviour: ". Thereafter you may give a description of the system's behaviour or add any kind of meta-information about the behaviour. You may use an arbitrary number of free text lines for this purpose. The first XXID line indicate the end of meta information lines. These behavior level meta data is called main header. A well structured nlxx with more than XX looks that way:

Behaviour: Manage orders
The order management view allows to create new orders and to modify or close existing ones.
Requirement 1.2
User story 1.2.1: As a customer, I wish to create an order in order to start a business process.
User story 1.2.2: As a customer, I wish to modify an order in order to adapt it to new conditions.
User story 1.2.3: As a customer, I wish to close an order in order to illustrate that all work for is done.

XXID: Create order
...

XXID: Modify order
...

XXID: Close order
...

For each XX definition some meta-information is required. For example, a unique XXID must be defined. Optionally, a XX may be marked by one or more tags. Meta-information is provided by so-called stage instructions. Stage instructions consist of a keyword followed by colon followed by a value. A group of stage instructions in the beginning of a XX definition is called subheader or XX header. For readability reasons, the meta-information-header and the instructions should be separated by one or two empty lines.

Within each XX the different test phases should be made visible by using the stage instruction 'Test-Phase:'. A well structured XX looks that way:

XXID:  Import order
Tags:  Order Management

Test-Phase: Arrange
...

Test-Phase: Act
...

Test-Phase: Assert
...

For further information about writing nlxx files see Managing XXIDs and execution tags.

---

Previous | Next