Process Requirements#
Requirements Structure
|
status: valid
|
||||
Requirements shall be hierarchically grouped into three levels. Following levels are defined:
|
|||||
Process Requirement Attributes#
Requirement attribute: UID
|
status: valid
|
||||
Each requirement shall have a unique ID. It shall consist of three parts:
Consider the project’s naming convention. |
|||||
Requirement attribute: title
|
status: valid
|
||||
The title of the requirement shall provide a short summary of the description, but is not an “additional” requirement. This means for example that the word “shall” is not allowed in the title for all requirements. |
|||||
Requirement attribute: description
|
status: valid
|
||||
Each requirement shall have a description. Note ISO/IEC/IEEE/29148 - Systems and software engineering — Life cycle processes — Requirements engineering defines general concepts including terms and examples for functional requirements syntax. The concepts shall apply. |
|||||
Requirement attribute: type
|
status: valid
|
||||
Each requirement, apart from process and tool requirements, shall have a type of one of following options:
|
|||||
Requirements attribute: security
|
status: valid
|
||||
Each requirement, apart from process and tool requirements, shall have a security relevance identifier:
|
|||||
Requirement attribute: safety
|
status: valid
|
||||
Each requirement, apart from process and tool requirements, shall have a automotive safety integrity level (ASIL) identifier:
|
|||||
Requirement attribute: status
|
status: valid
|
||||
Each requirement, apart from process and tool requirements, shall have a status:
|
|||||
Requirement attribute: rationale
|
status: valid
|
||||
Each stakeholder requirement shall provide an attribute called rationale. The rationale shall contain the reason why the requirement is needed. |
|||||
Requirement attribute: valid_from
|
status: valid
|
||||
Stakeholder and feature requirements shall and component requirements can have a validity attribute that tells from which milestone onwards the requirement is part of a feature. This validity attribute is defined as including the defined milestone. Milestone should be a valid platform release version tag, e.g. v1.0.2 as defined in Platform Release planning. If a requirement is not planned already this can also be a potential future milestone. The corresponding requirement is valid from the defined milestone, including it. |
|||||
Requirement attribute: valid_until
|
status: valid
|
||||
Stakeholder, feature and component requirements can have a validity attribute that tells until which milestone the requirement is part of a feature. This validity attribute is defined as excluding the defined milestone. Milestone shall be a valid platform release version tag, e.g. v1.0.2 as defined in Platform Release planning. The corresponding requirement is only valid until the defined milestone, excluding it. |
|||||
Process Requirement Linkage#
Requirement Linkage
|
status: valid
|
||||
Requirements shall be linked to its adjacent level via the attribute derived_from.
|
|||||
Requirement Linkage to AoU
|
status: valid
|
||||
Requirements shall be linked to AoU via the attribute covers, if they already cover these.
Note: “Already” illustrates the understanding that AoU come from used (external) components which appear later in the development (after deciding an architecture). |
|||||
Requirement Traceability
|
status: valid
|
||||
Bi-directional traceability shall be provided by adding a “back-link” via attribute derives (i.e. make a <-> out of the <- in Requirement Linkage). |
|||||
Requirement attribute: link to implementation
|
status: valid
|
||||
It shall be possible to link requirements to code (to the respective line of code in an attribute of the requirement). |
|||||
Requirement attribute: link to test
|
status: valid
|
||||
It shall be possible to link requirements to tests and automatically include a link to the test case in the attribute testlink. |
|||||
Requirement attribute: complete test coverage
|
status: valid
|
||||
It shall be possible to specify if a requirement is completely satisfied by the linked test case(s).
|
|||||
Requirement attribute: versioning
|
status: valid
|
||||
A versioning for requirements and AoU shall be provided. For this all significant attributes shall be taken into account: see Requirements Versioning |
|||||
Requirement invalidation
|
status: valid
|
||||
If a requirement or AoU is withdrawn for all releases, it shall be set to status invalid and all
references to it shall be removed or redirected to its successor in the same pull request. This covers
links of other needs, links of tests (PartiallyVerifies, FullyVerifies), links of code and references in
descriptions ( Note: The links of needs and tests are checked automatically by Requirements linkage status and Verification Link Status Check. Links of code and references in descriptions are checked in the review of the pull request. |
|||||
Requirement release scope
|
status: valid
|
||||
A requirement or AoU shall be part of a platform release vN if its status is valid and vN lies within its validity range: valid_from <= vN < valid_until (see Requirement attribute: vali... and Requirement attribute: vali...). A missing valid_until does not limit the range. A requirement without own validity attributes inherits the range of the requirements it is derived from. The documentation, traceability, checks and verification coverage of a release shall only consider the requirements and AoUs in its scope. A requirement keeps status valid when its valid_until milestone is reached, as it is still in force for earlier releases which may still be in use and maintained. From then on it may be deleted from the main branch; its specification stays available in the release branches and tags of the earlier releases. Status invalid is only used for requirements which are withdrawn for all releases (see Requirement invalidation). |
|||||
Process Requirements Checks#
Requirement check: suspicious
|
status: valid
|
||||
Based on the requirement versioning it shall be checked if a requirement was updated but not the linked tests and code. |
|||||
Requirements mandatory attributes provided
|
status: valid
|
||||||||||||||
It shall be checked if all mandatory attributes for each requirement is provided by the user. For all requirements following attributes shall be mandatory:
There is one exception from the above: “rationale” attribute is mandatory only for stakeholder requirements. |
|||||||||||||||
Requirements no weak words
|
status: valid
|
||||
It shall be ensured that no weak words are contained in the requirement description for:
List of these weak words: just, about, really, some, thing, absolutely (to be extended) |
|||||
Requirements linkage level
|
status: valid
|
||||
Every feature- and component requirement shall be linked to at least one parent requirement according to the defined traceability scheme: |
|||||
Requirements mandatory architecture linkage
|
status: valid
|
||||
Every feature- and component requirement shall be linked via satisfied_by at least to one valid architectural element on the same level.
|
|||||
Requirements linkage architecture
|
status: valid
|
||||
It shall be checked if every feature requirement is linked via fulfilled_by at least to one valid architectural diagram/interface on the same level. This should also include requirement type checking:
Note that the linking done via “fulfils” from the architecture element to the requirement as described for example in Allocate feature requirements to architectural elements. |
|||||
Requirements linkage architecture switch
|
status: valid
|
||||
The check Requirements linkage archit... shall only be enabled for a release build, otherwise it would block creating requirements first without architecture. |
|||||
Requirements linkage safety
|
status: valid
|
||||
It shall be checked that (child) QM requirements (Safety == QM) can not be linked against a (parent) safety requirement (Safety != QM). Note: This ensures that safety requirements are properly derived into their children. Also a mix of safe and QM aspects in a parent is avoided by this. |
|||||
Requirements linkage security
|
status: valid
|
||||
It shall be checked that every security relevant requirement (Security == YES) which has child requirements has at least one security relevant child requirement (Security == YES). Note: Unlike Requirements linkage safety, a child which is not security relevant may be derived from a security relevant parent, because a parent is commonly refined into security and non-security aspects. What the check prevents is the security aspect being lost in the refinement. |
|||||
Requirements linkage status
|
status: valid
|
||||
It shall be checked that every link attribute (e.g. derived_from, satisfies, covers) of a valid requirement or AoU (status == valid) contains at least one valid need (status == valid). If the linked needs have validity attributes (Requirement attribute: vali..., Requirement attribute: vali...), the validity range of the linking requirement or AoU shall lie within the validity range of at least one valid linked need per link attribute (e.g. a requirement valid_from v2.0.0 shall not be derived only from a requirement valid_until v2.0.0). So in every release a linked need is also part of the release scope (see Requirement release scope). A finding of this check shall fail the documentation build. Additional links to invalid needs shall be reported as a warning. Note: Without this check a valid requirement may trace only to invalidated parents, so that the traceability looks complete although it ends in requirements which are no longer in force. |
|||||
Requirements validity
|
status: valid
|
||||
Validity attributes (Requirement attribute: vali... and Requirement attribute: vali...) shall be checked for correctness (i.e. they denote an existing milestone) and consistency (e.g. the until is not before from). Requirements which are not in the scope of the next release (see Requirement release scope), i.e. future requirements with valid_from after the next milestone, shall only be checked formally:
|
|||||
Process Requirements Monitoring#
Requirement linkage complete
|
status: valid
|
||||
Valid stakeholder and feature requirements shall be reported which are not linked by a valid child requirement (i.e. no valid feature, component requirement has a derived_from link pointing to those). |
|||||