Skip to content

lab_11.md

Latest commit

 

History

History
84 lines (53 loc) · 2.31 KB

lab_11.md

File metadata and controls

84 lines (53 loc) · 2.31 KB

Lab 11

Sit with your Project team.

Goal

Ensure our Project setup instructions, code, and analysis are clear

Document

10 minutes

Pair in your Project team to add setup instructions to your README, taking someone from zero to the app running with populated data. You can assume they:

  • Know Python
  • Are comfortable in the command line

Send pull request(s) and merge.

Usability testing

Your Project team is going to pair up with another one, being each others' test facilitators and participants. You'll be checking/validating the usability of the code, documentation, and site.

Roles

Facilitators

The Project owners will be the facilitators. Facilitators will:

  • Do as little speaking/pointing/grimacing/etc. as possible
  • Take notes
    • What are participants getting confused by / stuck on?
    • What steps did they need to take that aren't documented (well)?
    • What can be clearer?

Participants

The other team are the test participants. The task is to set up and review the Project, thinking out loud.

Steps

30 minutes for each Project, with break in between

  1. Pick one Project to test first.
  2. Pair up, one facilitator with one participant (roughly).
  3. Participants will:
    1. Set up the Project.
      • Get the app running locally; you don't need to deploy it.
      • Try to follow the instructions exactly, only going back to perform missing steps when you hit a problem.
      • Everyone should have read-only access to each others' BigQuery.
      • Don't worry about performing the data loading.
      • Timebox this to 20 minutes.
    2. Review the code, explaining out loud what you think it's doing.
    3. Review the site.
      • If you're unable to get it running locally, you can look at the published site.
      • What is the site trying to convey?
      • What are your takeaways?
  4. Repeat for the other Project, switching roles.

Regroup

Remaining time

In your Project team:

  1. Discuss your takeaways.
  2. Revise your code/documentation.
  3. Send pull request(s) and merge.

Submit links to your pull requests via CourseWorks.