DISCUSSION: Resources for cohorts

[Nolski]

Overview

I wanted to start a discussion about where we will be spending out effort when delivering physical/digital resources beyond specific guidance among the companies and organizations we are working with.

Details

I think each resource we propose should hit a few qualities

• They should come from a specific need that we have identified from our intro calls or follow up meetings
• They should have a measurable impact on our grading rubric
• They should be generalizable that new organizations should be able to use them.

Outcome

We want to have a set of ideas for resources that can branch out into their own tickets for us to begin creating.

[Nolski]

Here's a couple of ideas I've had in no particular order:

Data Schema document

A lot of AI focused products are hesitant about releasing their data. Personally, I think we should encourage this in a way that's responsible.

The OCHA Humanitarian Data Exchange has some guidelines on identifying privacy risk to data sets but it's fairly vague. I reached out via email to see if they have additional guidance on how to determine whether a dataset should be public or private. They also have a little overview on using metadata to describe datasets

There was a paper written on this as well: https://arxiv.org/abs/1803.09010

Machine Learning Model Card Template

This stems from my talks with MacroEyes and Har Zindagi. They both are wary about releasing their machine learning models as they might be used improperly or not understood correctly. I think we could really provide a useful resource that hasn't been used beyond more than one project yet.

I was reading a white paper a while back which researched this quite a bit. Perhaps we could also adapt the publiccode.yml document created by the public code network?

The Perfect README Template

A lot of companies have asked for guidance on how to write good documentation. I think this is a quick and easy way to start delivering that guidance. We can expand from here.

This would be just a broad outline for a good README with all of the proper bits prefilled in. Some existing resources for this from a quick google search below:

• https://www.makeareadme.com/
• https://gist.github.com/PurpleBooth/109311bb0361f32d87a2
• https://medium.com/@meakaakka/a-beginners-guide-to-writing-a-kickass-readme-7ac01da88ab3

[jwflory]

I'm a little spent and will try to give this a more detailed look later this week, but here's some things to drop in the hat for now:

• The Open Organization Maturity Model: Framework used by Red Hat for helping an organization become more transparent, inclusive, adaptable, collaborative, and communal
• READMEs:
  • A maturity model for READMEs: Developing and writing READMEs for open source products, inspired by Red Hat's Open Org Maturity Model
  • feedmereadmes: Free README reviews by community; it doesn't look like this work is currently active, but check out all these yummy resources baked into its inspiration doc

[jwflory]

I'd like to commandeer this issue to be a unified place of discussion for where and how we move some of our content in the Shared Drive to the Resources site. This is something we've wanted to do for a long time. After I went through a lot of cruft in migrating our Google folder / presence, I think it is worth the time and effort to move much of that static content into git.

My primary focus for now is getting a new page up for Open Hardware, since this is the current priority of the existing cohort. Several awesome folks emailed me some great content and resources, and I want to start that section off on the right foot by adding it to the public site instead of spinning off another GDoc.

Once I complete the Open Hardware bit, I intend to start migrating existing content out from Drive and into the Hugo site.

[ghost]

On Tue, Mar 24, 2020 at 12:27:37PM -0700, jwflory wrote: and I want to start that section off on the right foot by adding it to the public site instead of spinning off another GDoc.

<3 (Also, just gonna mention here that this is where my #27 has gotten pointed. I know Github's web interface will display cross-referenced mentions but doesn't look like that makes it into the email notifications, which are my usual first stop, so here we are. No big deal I hope.)