ConsumerDataStandardsAustralia / standards-maintenance

This repository houses the interactions, consultations and work management to support the maintenance of baselined components of the Consumer Data Right API Standards and Information Security profile.
41 stars 9 forks source link

Add RFC8174 to list of normative references and update the use of Requirements Levels #473

Open CDR-API-Stream opened 2 years ago

CDR-API-Stream commented 2 years ago

Description

RFC8174 - Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words provides an update to normative reference RFC 2119 - Key words for use in RFCs to Indicate Requirement Levels for Requirement Levels such that requirement levels must be capitalised. This change considers the options for inclusion of RFC8174 as a normative reference and standardisation of requirements level usage in the Data Standards to be capitalised.

Area Affected

Normative References - Requirements Levels and non-capitalised usage of requirement levels.

Change Proposed

A) Update all usage of requirements levels to adopt the capitalised form. B) Update normative references with [RFC8174] in addition to [RFC2119] C) Update the Data Standards introduction with respect to requirements levels as appropriate with reference to [RFC8174]

Optionally: Community feedback has also identified BCP14 - Key words for use in RFCs to Indicate Requirement Levels as an option for best practice usage of requirements levels and usage within the Data Standards. This best practice document communicates the appropriate use of words and capitalisation similar to RFC8174.

Further analysis: Analysis of the update are published here: https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/blob/master/reviews/2021-05/analysis/analysis-rfc2119-rfc8174-20210519.md

nils-work commented 1 month ago

As a starting point, proposing the following changes to be made: