Skip to content

Eliminate language of "building blocks" #1347

@jpmckinney

Description

@jpmckinney

The new Primer explains the concept of the "schema" – a term we use frequently. "Building blocks" is not very helpful, because:

  1. It is a metaphor for an abstract concept (sub-schema). Using familiar words in a metaphorical sense to describe an abstract concept just adds another layer of abstraction and is harder to understand.
  2. Having learned the term "schema", the term "sub-schema" is much easier to understand, as it expresses the relationship between the two concepts (e.g. the Organization sub-schema is part of the Release schema).
  3. Publishers do not "build" OCDS data like LEGO blocks. The mapping step is more like using a lookup table and documenting relationships. If we were to retain a metaphor, "build" is not the right one.

Thankfully, there are only about 14 occurrences in the current documentation, so this should be quick. In some contexts, "object" is a more appropriate replacement (where it refers to the data representation, not the schema representation).

Metadata

Metadata

Assignees

Labels

Focus - DocumentationIncludes corrections, clarifications, new guidance, and UI/UX issues

Type

No type

Projects

Status

Review in progress

Relationships

None yet

Development

No branches or pull requests

Issue actions