Uploaded image for project: 'Technical Advisory Board'
  1. Technical Advisory Board
  2. TAB-1265

SHOULD vs. should keywords

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: New
    • Priority: Blocker
    • Resolution: Unresolved
    • Affects Version/s: Darwin Information Typing Architecture (DITA) Version 1.3 CSPRD01
    • Fix Version/s: None
    • Component/s: Public reviews
    • Labels:
      None
    • Environment:

      Normative

    • Proposal:
      Hide

      Review to verify that the 100 instances of SHOULD are the only RFC 2119 requirements for conforming DITA implementations and documents.

      If "should" is used for such a requirement, the text should be revised to use UPPERCASE SHOULD as per RFC 2119.

      Show
      Review to verify that the 100 instances of SHOULD are the only RFC 2119 requirements for conforming DITA implementations and documents. If "should" is used for such a requirement, the text should be revised to use UPPERCASE SHOULD as per RFC 2119.

      Description

      The current draft includes 100 instances of SHOULD and 428 instances of should.

      What is the meaning in difference of UPPERCASE versus lowercase?

      RFC 2119 says that UPPERCASE is normative and lowercase is normal usage.

      Is the difference in case intentional?

      As I noted in TAB-1264, a reader is left to wonder if SHOULD announces all the requirements for conformance under section 4 or are some of the "should"s meant to voice requirements as well?

      This comment applies to all three versions.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              patrick Patrick Durusau
            • Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated: