Uploaded image for project: 'Technical Committee Administration'
  1. Technical Committee Administration
  2. TCADMIN-3795

Update Keyword Guidelines for OASIS Specifications and Standards

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Component/s: Investigate an issue
    • Labels:
      None
    • Environment:

      TC Admin

      Description

      "Keyword Guidelines for OASIS Specifications and Standards" [1] needs to be updated.
      is fairly outdated, and no longer tracks with the OASIS publication templates.

      It was developed by the TAB, but there was no response from any TAB member to an earlier request to coordinate on updating it.

      DESCRIPTION OF TASK

      Both the IETF and ISO/IEC keyword lists themselves, and the references for those keywords, need to be updated.
      It appears that there are at least some minor edits needed to the "Mapping Table" as well.

      IETF

      • now includes "NOT RECOMMENDED"
      • now includes references to BCP 14 and RFC 8174 in addition to RFC 2119.

      ISO/IEC

      • deprecates "need not"
      • adds "may" and "may not"
      • above are relative to Fifth Edition, 2004
      • Eighth Edition is now current (2018)

      The relevant current descriptions and references are:

      IETF key words description:
      The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] and [RFC8174] when, and only when, they appear in all capitals, as shown here.

      ISO/IEC key words description:
      Within the normative text of this specification, the terms "shall", "shall not", "should", "should not", "may", "may not", "can", and "cannot" are to be interpreted as described in "Verbal forms for expressions of provisions", Clause 7 of [ISO/IEC Directives].

      [RFC2119]
      Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, <http://www.rfc-editor.org/info/rfc2119>.

      [RFC8174]
      Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017, <http://www.rfc-editor.org/info/rfc8174>.

      [ISO/IEC Directives]
      ISO/IEC Directives, Part 2 (Eighth edition) Principles and rules for the structure and drafting of ISO and IEC documents, International Organization for Standardization and International Electrotechnical Commission, 2018. https://www.iso.org/sites/directives/current/part2/index.xhtml.

      [1] https://www.oasis-open.org/policies-guidelines/keyword-guidelines

        Attachments

          Activity

            People

            • Assignee:
              paul.knight1 Paul Knight
              Reporter:
              paul.knight1 Paul Knight
            • Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated: