Keywords - Not identified/used correctly

XMLWordPrintable

    • Type: Bug
    • Resolution: Unresolved
    • Priority: Major
    • None
    • Affects Version/s: Business Document Envelope Version 1.0 CSPRD01
    • Component/s: Public reviews
    • None
    • Environment:

      Normative

    • Hide

      Review all uses of "must" and:

      Use keywords in all caps in normative text.

      Avoid using keywords in non-normative text (such as requirements). But certainly do not use keywords in CAPS in non-normative text.

      The UPPER/lower case distinction will help implementers recognize requirements for conformance.

      Not following that distinction is a "style" that leads to confusion.

      Show
      Review all uses of "must" and: Use keywords in all caps in normative text. Avoid using keywords in non-normative text (such as requirements). But certainly do not use keywords in CAPS in non-normative text. The UPPER/lower case distinction will help implementers recognize requirements for conformance. Not following that distinction is a "style" that leads to confusion.

      Section 1.1.1 Key words reads:

      *****
      The key words must, must not, required, shall, shall not, should, should not, recommended, may, and optional in this document are to be interpreted as described in [RFC 2119]. Note that for reasons of style, these words are not capitalized in this document.
      *****

      While not reflected in this comment, the keywords are written in the standard in italic.

      There are no instances of these keywords appearing in italic in the rest of the draft.

      Moreover, must appears in all caps once: 3.1 The envelope class, BDE-03.

      There are 41 instances of "must" (aside for the all caps case and in section 1.1.1) scattered through the document, including in clearly non-normative material.

            Assignee:
            Unassigned
            Reporter:
            Patrick Durusau
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated: