Page Comparison

...

• The tables

• The key patterns

• The Requirement Types

• The writing style

Best Practice 1: Put your requirements in Tables

...

1. 1 Row = 1 requirement

2. 1 Column = 1 data type, also called properties.

3. This will allow us to read and interpret your data, to give you:

   1. Structured requirements

   2. ReportingQuality reporting

   3. Easy Navigation and lecture

...

Best practice 2: Define your key patterns

Each requirement key is unique, and the key pattern will help you If you want to identify and organize the types of requirements you are creating. You’ll If you want to be able to use the a quick search, and filter your traceability matrices requirements based on the key, then defining unique key patterns is important. Once your key patterns they are created, it will also ease the flow of creation as we’ll be able to autosuggest the next requirements.

...

• I am writing my requirements one by one, as I create my specifications

  • Use the /req shortcut to add our macros. You’ll be able to write your requirement key and insert it.

• Inserting the requirement macro individually takes me too much time, I want to generate my requirements

  • Use the Transformation wizard in your table and select the rule ‘Generate keys’. Find out more in the documentation.

• I already have my requirement keys written in text, how can I transform the requirements?

  • Same as the point above, use the Transformation wizard and choose the rule ‘Transform text in keys’.

  • 💡 You can also do the same with requirement links, and transform mentions of existing requirement definitions. Read the docs.

• I want to ease the writing for my users, and create templates

  • Using the requirement types, you can create templates of pages that will help to fluidify facilitate the writing process of your users, making sure the requirements have the correct properties. See more in the next Best Practice.

Best Practice 4: Organize your requirements per type

Combining If you’re looking for a way to combine all the best practices above , the requirement types will help you bring so you can have more clarity and structure over your different key patterns. You will also requirements, be able to create requirements more efficiently with templates, and check the compliance of those requirements, then Requirement Types are your answer.

• Create your requirement type and choose the key pattern, replacing the numbering by %.

• Assign the properties and external properties desired, and make them required to trigger a validation.

• Save your requirement type.

• Create a page from this requirement type, and see your requirement type.

...