Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Contributing: Update style guide #275

Open
5 tasks
jpmckinney opened this issue Jan 11, 2023 · 1 comment
Open
5 tasks

Contributing: Update style guide #275

jpmckinney opened this issue Jan 11, 2023 · 1 comment

Comments

@jpmckinney
Copy link
Member

jpmckinney commented Jan 11, 2023

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.

  • Consider - Creating a unified style guide “checklist” for contributors to review before making new contributions to OCDS to ensure that policies are applied consistently across contributors.
  • Consider - Combining this page with the Handbook style guide and expanding guidance offered to be more detailed for contributors.
  • Consider - Adding guidance around page hierarchy in OCDS.

Admonitions

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

  • Consider - Compiling all uses of admonitions in one place to compare/contrast formats and purpose of the admonition.
    • Bloom's taxonomy can be a useful orientation for the admonitions and learning objectives (I think we have admonitions for "Remember", "Understand", "Apply"). That said, in some cases, admonitions are not related to learning, like invitations to contribute to a GitHub issue, or a note about the version in which something changed. Still, the taxonomy generally orients toward using verbs, which can be applied outside of learning objectives (using "Contribute" for the Github example).
  • Consider - Using one color admonition (I recommend green) for examples throughout OCDS.
jpmckinney added a commit that referenced this issue Jan 11, 2023
@jpmckinney jpmckinney changed the title Various improvements from documentation review Contributing: Update style guide Jan 11, 2023
@jpmckinney
Copy link
Member Author

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.

  • Consider - Converting Google docs to online pages where possible to keep all documentation and guidance in a similar place and improve policy application.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant