open-contracting / standard-development-handbook

A guide for authors of the Open Contracting Data Standard
http://ocds-standard-development-handbook.readthedocs.io/en/latest/
Other
6 stars 3 forks source link

Contributing: Update style guide #275

Open jpmckinney opened 1 year ago

jpmckinney commented 1 year ago

Full 2020 document: https://docs.google.com/document/d/1Tl_0vv1QTt1UzJ2WGie5gOFyG6CTzILtSkiChglJ0BQ/edit

These are from the heading "Contributing to OCDS". There are comments on some of these points in the document.

Note that the handbook has changed a bit since then.

Style guide

Currently guidance is divided into several parts with different levels of importance and consistent usage across the sections.

Admonitions

As noted above, the use of admonitions is inconsistent across the OCDS, with a variety of terms and formats used interchangeably.

jpmckinney commented 1 year ago

Google Docs

Google docs and development handbook - The development handbook currently consists of a variety of pages in online format, linking to Google docs and other materials.