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

META: Limiting the size of the OCDS documentation #1288

Closed
jpmckinney opened this issue Apr 28, 2021 · 1 comment
Closed

META: Limiting the size of the OCDS documentation #1288

jpmckinney opened this issue Apr 28, 2021 · 1 comment
Labels
discussion Focus - UX Making information easier to find and interpret

Comments

@jpmckinney
Copy link
Member

jpmckinney commented Apr 28, 2021

The progress of the number of words in the documentation is:

1.1.0: 38,907
1.1.1: 35,660
1.1.2: 35,339
1.1.3: 35,581
1.1.4: 33,313
1.1.5: 53,242
current: 54,844

Adding the worked examples in 1.1.5, as expected, added a lot of words. We should consider limiting the growth of the documentation in order to:

  • Keep the documentation to a size that users can still grasp
  • Lower the intensity of translation work (community translations and the French translation are already unmaintainable)
  • Lower the maintenance effort of keeping all pages in sync with changes to the standard

To do this we might:

  • Monitor the use of worked examples. Rarely referenced worked examples might be removed.
  • Remove guidance that is outside the normative scope of OCDS (replace with links to good resources)
  • Remove other rarely referenced guidance

We are already:

@jpmckinney jpmckinney added Focus - Documentation Includes corrections, clarifications, new guidance, and UI/UX issues discussion labels Apr 28, 2021
@jpmckinney jpmckinney changed the title Limiting the size of the OCDS documentation META: Limiting the size of the OCDS documentation May 19, 2021
@jpmckinney jpmckinney added Focus - UX Making information easier to find and interpret and removed Focus - Documentation Includes corrections, clarifications, new guidance, and UI/UX issues labels Nov 22, 2021
@jpmckinney
Copy link
Member Author

Closing as the size of the content has stabilized.

We can identify and cut low-value content per above, as needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion Focus - UX Making information easier to find and interpret
Projects
None yet
Development

No branches or pull requests

1 participant