Documents requirements of a product.
- ID
requirement- Suite
- Parent
- Documentation Type
- Categories
- Tags
Properties
The document type requirement provides the following properties:
Please note that only information about specific properties is provided here. Common document property used by all document types are documented by Document Properties.
Identifier
Define the unique identifier of the requirement.
See Auto Increment for support of autocreation of this property.
The topic Auto Increment in Title provides a couple of videos to see the Auto Increment Feature in action.
Type
The type of the requirement for grouping and selecting.
Define the requirement types for your project with doctype Requirement Type.
Quality
Reference the quality that is affected by this requirement.
Business Importance
Specify the importance of this requirement according to business goals.
You may also remove the macro value and replace it with a Name List Macro and its own type. You may also use the Priority Macro, if you require more categories.
Technical Difficulty
Specify the difficulty to implement this requirement from a technical view.
You may also remove the macro value and replace it with a Name List Macro and its own type. You may also use the Priority Macro, if you require more categories.
Sections
Quality Scenarios
List of all quality scenarios that are linked to this requirement.
Notes
These are internal notes that are usually not exported and only visible to team members with write access.
But this is not a safe place to store sensible information. It is just a convenience for the reader to not be bothered with notes stored here for the authors for later use. The security level is about suppressing the representation by a CSS style. Therefore consider this as a convenience for the reader, not as a security tool.
The text of notes sections is also indexed.
References
For a document the references section contains pointers to resources that prove the statements of the document.
Often these proofs are not easily distinguishable from further information. In this case you may want to skip the reference section in favour for the resource list.
For further information please refer to References and Resources.
Resources
The resources section provides references to further information to the topic of the document.
This may be information on the internet provided by the resource or information in the team's information systems. Anything the reader of the resource might want to know, may be listed here.
For further information please refer to References and Resources.
Related Doctypes
- Requirement Type
- Defines the types of requirements used in your project. Usually these types are usually shared between projects. See Delegate Space for details.
- Quality
- Defines the quality that is affected by the requirement. These types are usually shared between projects. See Delegate Space for details.
- Quality Scenario
- Reference requirements they are based on.