From Dig Platforms & Data - policy perspective

[jlabelle]

Hi Ruonan,
Reviewing from a non-technical perspective, I have a few comments:

• Consider including a Definitions section, or adding a few defs within the document. I noted a few terms that may need a description to ensure the document is widely accessible: BC Data Catalogue, OAUTH token, CI/CD pipeline.
• "API Store" - suggest this term be replaced with "BC Government API Registry"
• open source software - a few tools are mentioned in the guide and, to ensure employees are aware of requirements for acquiring open source software, consider including a link to the Guidelines on the Use of Open Source Software, and the BC Open Source Development Employee Guide for Github contributions. Also suggest consistently including hyperlinks to promoted tools (e.g."Postman" and "curl").

Thanks !
Julie

[jeff-card]

Thank you for your comment! A peer review was held on August 9th and we have the following feedback:

· A glossary of terms is a helpful suggestion and worth having. How much gets defined is worth considering; these guidelines were written with developers in mind, and the assumption is they will have a certain literacy level already. We have also discussed and developed a plain language accompaniment to these guidelines for a non-technical audience.

· We will remove the reference to “API Store” entirely, since there isn’t one.

· Getting too detailed about tools is beyond the purview of this document, though we will certainly implement the suggestion to hyperlink “postman” and “curl”. In the case of guidelines for the use of open source software, we feel this would be better suited to reside on the DevHub, given it is already a place for resources like this