Menu

#13 Conventions: How to write requirements that are related to the CT model?

12.0 Q2-2021
open
Martin
None
2021-04-22
2020-12-21
Martin
No

**Challenge: **

The requirements have to be understandable independently, especially independent from their place in the document or in the ReqIF representation, respectively.


**Solution: **

Using the nomenclature common name to reference the CT element, e.g.

  • this CHANNEL -> gas supply configuration CHANNEL
  • this METRIC -> infrastructure gas pressure METRIC

If this is not suitable, the RefID can be used, however, due to the readability, this is not the preferred way.

**Implications: **

  • The Common Names of all terms the to be written in a proper way
  • Tooling support would be great in a way that we can use references in the requirements and the nomenclature table is the single source of truth

Update:

We are going to use wording like:

  • this CHANNEL -> CHANNEL with pm:Type/@Code = XYZ
  • this METRIC -> METRIC with pm:Type/@Code = ABC

This makes it very clear. However, the readability is a bit less smooth, nevertheless, clarity is more important in standards.

Discussion

  • Martin

    Martin - 2021-04-12
    • Description has changed:

    Diff:

    --- old
    +++ new
    @@ -2,6 +2,7 @@
    
     The requirements have to be understandable independently, especially independent from their place in the document or in the ReqIF representation, respectively.
    
    +<s>
     **Solution:  **
    
     Using the nomenclature common name to reference the CT element, e.g.
    @@ -15,3 +16,14 @@
    
    
     * The Common Names of all terms the to be written in a proper way 
     * Tooling support would be great in a way that we can use references in the requirements and the nomenclature table is the single source of truth
    +</s>
    +
    +###Update:
    +
    +We are going to use wording like:
    +
    +- this CHANNEL -> CHANNEL with pm:Type/@Code = XYZ
    +- this METRIC -> METRIC with pm:Type/@Code = ABC
    +
    +This makes it very clear. However, the readability is a bit less smooth, nevertheless, clarity is more important in standards.
    +
    
     
  • Kathrin Riech

    Kathrin Riech - 2021-04-22
    • assigned_to: Kathrin Riech --> Martin
     

Log in to post a comment.

Auth0 Logo