Align table columns (and content type) to be consistent and create complete formal definitions.

XMLWordPrintable

    • Type: Task
    • Resolution: Fixed
    • Priority: Minor
    • None
    • Affects Version/s: None
    • Component/s: spec
    • None
    • Environment:

      Anne Hendry

    • Hide

      Clean up tables to have only 2 columns: Name and Definition.
      If 'Name' by itself seems too generic, could use 'EMIX Name', or 'Element Name', or 'Entity Name'.

      Create formal definitions for all rows ("the formal statement of the meaning or significance of a word, phrase, etc."). Use this in schema 'documentation'.

      For example, currently the row containing 'PackageDiscount' has no 'Definition' column. There is only a 'Note' column stating "There may be market reasons for the price to be different than the Extended Price." and a 'Specification' column that contains info about datatype and optionality/cardinality. We need the formal definitions to reduce uncertainty and time spent discussing what is meant and enable others (end users of the spec) to understand what is meant and to put in the schema 'documentation'.

      Show
      Clean up tables to have only 2 columns: Name and Definition. If 'Name' by itself seems too generic, could use 'EMIX Name', or 'Element Name', or 'Entity Name'. Create formal definitions for all rows ("the formal statement of the meaning or significance of a word, phrase, etc."). Use this in schema 'documentation'. For example, currently the row containing 'PackageDiscount' has no 'Definition' column. There is only a 'Note' column stating "There may be market reasons for the price to be different than the Extended Price." and a 'Specification' column that contains info about datatype and optionality/cardinality. We need the formal definitions to reduce uncertainty and time spent discussing what is meant and enable others (end users of the spec) to understand what is meant and to put in the schema 'documentation'.
    • Hide

      Updated, two columns in all tables, published in WD20

      Show
      Updated, two columns in all tables, published in WD20

      The current table structure describing entities/elements varies significantly from section to section:

      • some tables have 2 columns, some 3, some 4
      • tables have varying combinations of 'type', 'notes', 'definition', 'specification'
      • content of 'type', 'notes', 'definition', 'specification' is often interchanged/intermingled
      • the first column titles vary:
        'name' (most used), 'time segment', 'term', 'intrinsic element', 'extrinsic element', 'warrant element', and 'product element'
      • some table columns are declared 'normative', others 'non-normative', others not stated

      Tables 3-3 and 11-1 contain very, very similar content, although not exactly the same; remove one?

            Assignee:
            William Cox (Inactive)
            Reporter:
            Anne Hendry (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved: