Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The practice of keeping to principle requires decisions to be made as to what questionnaire elements provide meaning. For example it was decided that bold font provided no semantic meaning and therefore CLOSER is not documenting the weight of the font. The The order of multiple choice options was deemed relevant and therefore special care is taken to preserve the order within the documentation.

...

2. Do not correct the questionnaire.

Principle 2 is the second most significant principle for ingesting metadata. It is fairly common to find what seem like mistakes in the questionnaire design; these can range from typos (e.g. 'martial status' instead of 'marital status') to impossible condition logic (e.g. asking when someone gave up smoking, within a branch of non-smokers).

Any mistakes within the questionnaire could have altered the data being collected, and therefore it is important to avoid correcting the metadata while documenting. Also, what seems like a mistake always has the potential of being done purposefully and therefore potential mistakes should be verified.

In the case of a typo, the misspelt word can be aliased within CLOSER Discovery to allow effective searching (e.g. searches looking for the 'marital', would also find aliased questions with the word 'martial').

There are rare situations where Principle 2 must be violated in order to follow Principle 1 and document meaningful metadata. A real-world example of this is when a code value is accidently printed with the wrong value. There is no easy way to alias code values and CLOSER's documentation would suggest that there are two distinctly different codes, while the dataset would only refer to one of the codes. In this case, documenting the mistake would mislead the user and violate Principle 1.

3. Only record what is contained within the questionnaire.

...