Skip to content

Commit

Permalink
schema_style_guide.rst: add guidance for authoring titles
Browse files Browse the repository at this point in the history
  • Loading branch information
odscjen committed Oct 9, 2023
1 parent 554203a commit 35d1fff
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/meta/schema_style_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,12 @@ Field and code names

Until OCDS 2.0, publishers must use the ``tender`` term, and not choose their own terms, in order to maintain interoperability. The choice of a term is cosmetic; it's not semantic. A field's description, not its name, is semantic.

Field and code titles
---------------------

- Use `sentence case <https://en.wikipedia.org/wiki/Letter_case#Sentence_case>`__.
- Field titles should not include their parent's title, e.g. ``Title`` not ``Tender title``, ``Description`` not ``Award description``, etc.

Field and code descriptions
---------------------------

Expand Down

0 comments on commit 35d1fff

Please sign in to comment.