Use case
Customers want to manage more than requirements. They also want to manage dictionaries, for example:
- An index of all error messages in the application,
- A list of part numbers.
We've arbitrarily defined that the property named "Type" would be a special case, it will contain the type of requirement. This is a standard property, as defined in Properties and RY Reports.
| Tip | ||
|---|---|---|
| ||
If your documentation already uses the "Type" for another purpose, it is not a problem. The only drawback is that the inline creation pop-up will contain a lot of entries in the drop-down. Given the pop-up is only used to create types, the UX impact will be limited. |
...
| Tip | ||
|---|---|---|
| ||
Those features were published in version 1.4 in March 2016. |
Annotate keywords, error messages and part numbers
We're introducing the dictionary blueprint in Requirement Yogi. It starts with a template where people can enter any kind of key/description entry:
The user can assign a color to distinguish, for example, error messages from normal messages:
Importing documents from the customer
People often have to quickly import new requirements from the customer. Requirement Yogi makes it very efficient. On a page, select a candidate for a requirement key. In the inline pop-up, click "Define as a requirement" or press Alt + Shift + R:
The list of types appear:
After you click Create, the requirement will be added to the blueprint page. All references in the page (and optionally in the space) will be transformed to links.
To speed up the conversion, if all requirements on your page start with "ODIS", then they can all be transformed and added to the blueprint.
This is a standard property, as defined in Properties and RY Reports.
Specification
Types rely on features which are already available in Requirement Yogi:
...
| Property | Value | EffectNotes |
|---|---|---|
Type | Any string |
|
_formatting | #color; bold; italic; underlined; |
|
Demonstration
|
...
The list of types appear:
...
...
Creating a new type
If you haven't defined any type yet, the form suggests to.
...
It
...
will use a blueprint to create the type.
...