search

edgi-govdata-archiving / web-monitoring

Documentation and project-wide issues for the Website Monitoring project (a.k.a. "Scanner")
Creative Commons Attribution Share Alike 4.0 International
105 stars 17 forks source link

Incorporating Best Practices for WM Tech #97

Closed lightandluck closed 5 years ago

lightandluck commented 6 years ago

This is a tracking issue for drafting Best Practices for working with WM Tech and incorporating them across EDGI. Within the working group we've determined that there are different questions we want to address. Draft for sections

  1. Process for how Steering Committee works with Web Dev team
  2. "What are we willing to offer people using our website monitoring platform?"
  3. "In an ideal world, what do we want back from our users?"
  4. "What do people need to know about our software to use it well beside the Best Practices we hope they will follow? How do we speak to our very different audiences?"
  5. "What do people need to do to use the tool well? What outcomes do we want to promote/avoid (e.g. misinterpretation of changes)?"

Also, there are a number of locations where these questions would be answered: a. Web monitoring project github README b. Invite email sent to new users of Scanner c. Within Scanner d. On the -db api page e. Web monitoring page on EDGI's website

These are next steps to getting drafts for each section done and where to place them:

@danielballan @Mr0grog and everyone else, please let me know if I missed anything. Also, I grouped related tasks for sections together but don't expect a single person to do every task.

Mr0grog commented 6 years ago

The invite email issue and draft is https://github.com/edgi-govdata-archiving/web-monitoring-db/issues/207

stale[bot] commented 5 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in seven days if no further activity occurs. If it should not be closed, please comment! Thank you for your contributions.

lightandluck commented 5 years ago

There's still parts of this that would be great to surface to contributors in READMEs

stale[bot] commented 5 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in seven days if no further activity occurs. If it should not be closed, please comment! Thank you for your contributions.