Uploaded image for project: 'OASIS Emergency Management TC'
  1. OASIS Emergency Management TC
  2. EMERGENCY-77

TEP 1.1 - TAB-1333: Use of shall as alternative to MUST?

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Component/s: EDXL-TEP
    • Labels:
      None
    • Environment:

      Normative

    • Proposal:
      Hide

      Check and correct "shall" to MUST as appropriate.

      Show
      Check and correct "shall" to MUST as appropriate.
    • Resolution:
      Hide

      Check and correct "shall" to MUST as appropriate.

      Show
      Check and correct "shall" to MUST as appropriate.

      Description

      The lowercase form of shall occurs five times, while MUST occurs 52 times in the text.

      The better usage is to chose one keyword, either SHALL or MUST and to stick with it. It is less confusing to the reader. Moreover, always use UPPERCASE when you intend a keyword.

      Cases of "shall" where I think you meant MUST:

      3 EDXL Tracking of Emergency Patients

      Section 3 of this Standard is normative unless otherwise stated. If any differences are found between any XML schema and its associated model, diagram, table or other artifact or text, then the XML schema shall always take precedence and the other artifact(s) must be changed to match the XML schema.

      4 Data Dictionary (normative)

      The data dictionary is intended to provide detailed definition of each element contained in the EDXL-TEP standard. Where discrepancies may exist between this dictionary, the Element Reference Model (ERM), and the normative schema, the normative schema shall take precedence.

      4 Data Dictionary (normative)

      Naming convention: in order to mark a clear distinction between elements and types, names of elements shall not contain the string “Type” and shall be formatted in camel-type (lower case leading alpha character); types are to be terminated by the string “Type” and shall be formatted in Pascal-type (upper case leading alpha character). Acronyms that are part of a type/element identifier should preserve their all upper case format.

      (3 instances)

        Attachments

          Activity

            People

            • Assignee:
              pattiaymond Dr. Patti Aymond (Inactive)
              Reporter:
              pattiaymond Dr. Patti Aymond (Inactive)
            • Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: