Generate and document resource and field description standards

[krivard]

Overview

Problems:

• Our data documentation is uneven / difficult to scan quickly
• It is difficult for users to identify the data they need; or identify what resources/fields contain the data they need
• Contributors don't know what to include in new resource/field descriptions, which impacts review time for new contributions

Proposal:

Set criteria for what information should be available in all resource/fields descriptions, so that for resources/fields that comply with the standard,
* Important characteristics of the resource/fields are guaranteed to be explicitly listed in the description, and not left unstated or implied
* Users will know where to look in the description for information pertinent to them

Success Criteria

How will we know that we're done?

• We have a new section or page in our documentation saying what users can expect to find / what new resource/fields proposals should provide in resource and field descriptions
• We have a list of our resources/fields saying whether they comply with the standard or not

Two phases:

• Research & Design - 10hrs
• Writing - 10 hrs

Next steps

Preview Give feedback

1. Collect data about resources and fields
2. Collect opinions / discussion
3. Draft standards
4. Approve standards