sklarcorp / data-style-guide

Describes the standardized practices, grammar, and vocabulary for product data.
www.sklarcorp.com
1 stars 1 forks source link

Proofer found `Inches (Decimal)` section confusing #34

Open mwmalinowski opened 10 years ago

mwmalinowski commented 10 years ago

She found the entire section confusing and said it seemed to contradict the Length section.

I think we need to make it clear that the details of Inches (Decimal) apply only to that field. We cannot let the reader potentially infer that the Inches (Decimal) rules apply to measurements in other fields.

mwmalinowski commented 10 years ago

@sklar-sherryp If you're wondering, I did Inches (Decimal) by surrounding the phrase with backticks (the key above Tab: ` )

sklar-sherryp commented 10 years ago

Should we rename the cells as "Length (Inches)" and "Length (Decimal)"?

It has been my understanding that is essentially what we are entering in those fields - specifically, the overall length of the instrument.

mwmalinowski commented 10 years ago

Not all of our Length measurements are in inches, but we need all of our decimal values in inches so they can be sorted correctly. That's why we have Length and Inches (Decimal).

sklar-sherryp commented 10 years ago

The cells Length and Inches (Decimal) are always related to one another correct? Perhaps we need to rename the cells so more of a direct connection is implied?

mwmalinowski commented 10 years ago

I think I have a solution to the confusion.

sklar-sherryp commented 10 years ago
  1. Removed the confusing explanation regarding Length vs. Width vs. Height measurements
  2. Revised a portion of the general explanation of Length field
sklar-sherryp commented 10 years ago
  1. Should the Inches (Decimal) field "officially" be renamed?
mwmalinowski commented 10 years ago

Yes, please.

sklar-sherryp commented 10 years ago

Changed Inches (Decimal) field name to Sorting Length (Decimal Inches)

mwmalinowski commented 10 years ago

Should we include an explanation of this field's purpose?

This field stores numerical values to allow instruments to be sorted by lengths.

Consider five hypothetical instruments: Clamp 1 1/2", Clamp 10", Clamp 2", Clamp 1 1/3", Clamp 1 3/16"

If you sort the Length field by ascending values you'll get name fields ordered as: Clamp 1 1/2", Clamp 1 1/3", Clamp 1 3/16", Clamp 10", Clamp 2"

If you sort by the Sorting Length (Decimal) you'll get the correct order: Clamp 1 3/16", Clamp 1 1/3", Clamp 1 1/2", Clamp 2", Clamp 10"

mwmalinowski commented 10 years ago

FYI, this has to do with the how computers interpret alphanumeric characters (e.g. "1") vs. numeric values (e.g. 1).

sklar-sherryp commented 10 years ago

I dont understand the example you provided. Is it able to be sorted because there is no "inches" symbol and no fraction?

mwmalinowski commented 10 years ago

If there are any non-numeric characters besides a decimal point then a computer will treat it as text.

Computers treat 3, 5.0002 as numbers. Computers treat 3,000, 54,200.03, $50, 3-1/2, 3/4, 1 1/2" as text.

Suffice to say, text and numbers aren't sorted the same--even if the text looks like it's just a number. Numbers that are treated as text (e.g. 10") will not sort correctly.

mwmalinowski commented 10 years ago

To see this first-hand, download this example spreadsheet.

First sort column B. Then sort column E. You should see that E sorts correctly and B does not.

I used Excel's formatting options[1] to treat column B as Text and column E as Number.

[1] Right click on a cell, row, column, or selection; choose "Format Cells..."; look at the leftmost tab.