Skip to content
Branch: master
Go to file
Code

README.md

What is the GenderMag Recorder's Assistant?

The GenderMag Recorder’s Assistant is a tool to identify gender-inclusiveness issues in software. GenderMag is a process you can use to find gender biases in user-facing software that you are designing/building. The GenderMag Recorder’s Assistant semi-automates using this process. It is easy to use and can be used by software engineers to management to usability experts.

If you want to help make software gender-inclusive, one way is to contribute to the GenderMag Recorder’s Assistant.

We welcome everyone with any background to contribute to making the world of software more gender inclusive.

Resources and Background Information

How to install the GenderMag Recorder's Assistant:

Method 1: Download from GitHub:

  1. Create a fork of the project to your GitHub account. For information on how to do this, please see this page.

  2. On the Recorder's Assistant GitHub page, click on "Clone or download" and then click "Download zip".

  3. Navigate to the folder on your computer where the zip file (not just the file folder) is located and extract the zipped files. (Right click on the zipped folder -> "Extract All")

  • After clicking on the intitial downloadeded file, navigate backwards one step in the Files app to reach the zipped folder.
  1. Open Chrome and click on the icon (⋮) in the top right corner.

  2. Click on “More tools” -> “Extensions”.

  3. Enable developer mode by checking the “Developer Mode” slider in the top right.

  4. Click on “Load unpacked” under the search bar.

  5. Select the extracted zip file and click "ok".

  • Don't select the standard file folder (only the zip file will upload).
  1. Click on “Update” under the search bar.

  2. The new extension called ”GenderMag Recorder's Assistant” should be in the top left corner of the extensions.

Method 2: Install from Chrome Web Store

For more details about extension installation click here

How to Run a GenderMag Session Using the Tool

A GenderMag session is simply an instance of using the GenderMag method. If you have downloaded and installed the tool and want to run it, make sure the extension is enabled, navigate to the page you wish to perform GenderMag on and click the GenderMag button at the bottom of the screen.

See the video from GenderMag.org for examples and/or read the guide below.

Here is a step-by-step guide on how to run the Recorder Assistant tool:

  1. After you have installed the GenderMag recorder's assistance extension a maroon button will appear on the bottom middle of the screen. Click it to open the tool.

  2. After clicking on the maroon button, text explaining what GenderMag is will appear on the screen. Click on "Start GenderMag" to get started.

  3. Enter the name of your team and click submit.

  4. Select the persona that you want to use for this session. Currently, you can select from these personas: Abi, Tim, Pat, or a custom persona of your creation.

    After you have selected the persona, the description of the selected persona you selected will appear to the right.

    • If you selected a custom persona, navigate to http://gendermag.org/custom_persona.php and design your custom persona using an online or PDF form. Your custom persona's facets and characteristics will be listed on these forms instead of in the GenderMag extension.

    If you want to change the persona or team name, click edit on top of the tool.

  5. Provide the scenario that your persona will be performing in the text box and click submit.

  6. Enter a subgoal and click 'enter subgoal'.

  7. Answer Yes, No, or Maybe to describe if the persona would have formed this subgoal as a step to their overall goal. In the text box, explain why, why not, or why maybe. On the right of that text box, select all the checkboxes corresponding to the facets that were used to answer the previous question. Then click save and continue.

  8. Enter an action that pertains to this subgoal.

  9. Click on the 'click here' button to take a screen capture of ideal action. Move the rectangular box around your box to the action that you want to focus on and hit the left click. This will create a screen capture of ideal action. If you want to add more info to the capture click on the draw on the image button and annotate the image. If the image looks okay, click 'save and continue'.

  10. Answer: Yes, No, or Maybe for, will the persona know what to do at this step, and in the text box under it explain why, why not, or why maybe? On the right of that textbox select all the checkboxes against the facets that were used to answer the previous question.

  11. Perform the action you indicated previously in step 9 and click on the 'click here' link to continue.

  12. Answer: Yes, No, or Maybe for, if the persona did the right thing will she know that they did the right thing, and is making progress towards the goal and in the textbox under it explain why, why not, or why maybe? On the right of that textbox select all the checkboxes against the facets that were used to answer the previous question. Click 'save and continue' when ready.

  13. If your persona needs another action to complete the current subgoal, enter the new action in the top text box and click 'add another action'. Return to (9) and complete all subsequent steps.

  14. If the subgoal is complete, but another subgoal is needed to complete the scenario, enter the subgoal in the bottom text box and click 'create new subgoal'. Return to (7) and complete all subsequent steps.

  15. If the scenario has been completed, click 'save and stop GenderMag session'. This will take you to another page and download a zip file with your session's information.

  16. If the zip file was not downloaded click Re-Download zip file. Otherwise, check the box next to the disclaimer saying that the file was downloaded and hit "Quit GenderMag". This will reload the page and close the tool.

See the video at http://gendermag.org for examples of what running the tool looks like.

How to Disable GenderMag:

  • To turn off the GenderMag extension navigate back to “Extensions” and uncheck the “Enable” box and uncheck “Developer Mode”.

Contributing

Please follow our Code Of Conduct and read our Contributing Guide.

FAQ’s:

Note: If you have questions you would like us to answer, please let us know by filing an issue asking the question!

  1. How to install GenderMag Recorder’s Assistant (chrome extension):
  2. Technologies used in the project:
    • HTML
    • CSS
    • JavaScript
You can’t perform that action at this time.