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

Create "Metrics explainer": Document for each metric how it is computed and how it impacts security #11

Open
jenniferfernick opened this issue Sep 28, 2020 · 1 comment

Comments

@jenniferfernick
Copy link

I am seeking to write a "metrics explainer" in which, for each metric on the dashboard, we document things like:

  • Security impact: Details about how a given metric relates to the security of software in general; rationale for its' inclusion and interpretation in the dashboard; other context that can help a user make an informed interpretation of a given metric
  • Computation of metric: How the metric was obtained or computed, including whether this is something our backend computes (and based upon what input) or something pulled from a third-party source
  • Interpretation of scores: What is the potential range of scores for the metric, and how to interpret a score

We will eventually publish this as a resource for users of the dashboard. TBD how we will integrate this (will discuss in a future meeting with @rhaning as we get closer to knowing the overall dashboard UX of the version for initial release)

In terms of next steps:

  1. @rhaning / @scovetta can you share (here or by email) a list of metrics which are intended to be present in the initial release?
  2. I will create a working draft, and share it here
  3. Anyone who would like to help should let me know - currently, the collaborators are me and @mayakacz

Feedback welcome!

@5stars217
Copy link

@jenniferfernick
Happy to help with this.

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

No branches or pull requests

2 participants