Join GitHub today
This document is targeted to software developers who need to understand the expectations for, and assumptions about, Phase 2.
Please see Introduction for a overview description of the M&I Map application (as implemented in Phase 1).
Advice for Next Steps
How to manage future software changes:
- Before beginning, team members should become familiar with the material in the wiki, and with git and GitHub.
- The Development Guide (in several sections) further orients team members, and describes the setup processes new team members will need to accomplish prior to contributing to the software.
- Specifically, the Contributing Guide (the CONTRIBUTING.md file in the repository) describes a method of managing the changes to the M&I Map software, by creating a new Issue to request (identify) a feature, committing (changed) code against that Issue, and then seeking review and approval from fellow team members.
Description of the Envisioned Phase 2 Process
The following workflow describes the expected work process, and what part the M&I Map system plays within the workflow, when Phase 2 is completed.
In Phase 2, Partners (people working at partner organizations) still start the process. They still gather information and write descriptions of their organization and the programs they offer, however in Phase 2 they will enter this information directly into the M&I Map system. However, before the information is available for inquiry or viewing by the public or advocates, an Administrator at HMHB must review, possibly edit, and approve it.
In Phase 2, the M&I Map system will notify Admin that new program or organization information has been submitted. Admin then reviews and approves the information, editing as necessary.
Once approved, program and organization information are available on the Map for viewing and inquiry by Advocates, and by the general Public. In Phase 2, we continue to expect that the Partner and Admin roles will be carried out on laptops or desktops, and that viewing and inquiry will support both mobile and stationary devices.
Features Planned to be Added in Phase 2
A partner can create/edit/update programs and organizations.
We envision in Phase 2 that partners will create/edit/update programs and organizations through a user interface identical to the user interface used by Admin for Phase 1 entry.
- We recommend that, before proceeding, the usability by partners be confirmed, or identify if changes to the user interface will necessary to support partners.
- We suggest that this usability test can be accomplished by creating a test instance on Heroku, running the current production code but updating a test database.
- Partners recruited to participate in the usability test can be given admin authority in the test instance, and then enter information into the test instance. This will test the assumption that partners (who may enter data less frequently) will find the system as usable, as compared to Admins (who will enter data more frequently during Phase 1).
For Phase 2, we expect a second set of database tables would be created that are identical to the current tables; these would hold partner entries that are awaiting approval. Note that if the logged-in user is an Admin, entries should continue to go directly to the original set of database tables, which will continue to be used to support inquiries on the Map.
The system notifies the Admin that there are partner entries to review.
In Phase 2, the final step of storing partner entries into the “awaiting approval tables” should generate an active notification to Admin (most likely an email). The next user story also includes a passive notification: when the Admin looks to see if there are entries to process, a list will be displayed.
An admin user can approve, edit, place on hold, or reject partner entries.
A prototype of the Phase 2 approval process has been developed and reviewed with HMHB personnel. This prototype starts with the Admin viewing a list of partner entries to process, and walks through two scenarios: placing a partner entry on hold (including setting a status and entering a reminder note), and approving a partner entry. Click here to view a brief video walkthrough of the prototype for Phase 2 Approval, or click here to run the Axure Phase 2 Interactive Prototype; the prototype may be accessed from (and run on) any computer with a web browser and an internet connection.
In the Phase 2 approval process, when an Admin approves a request, the appropriate rows from the “awaiting approval tables” will be deleted, at the same time as the corresponding rows are inserted into the “approved tables” (against which the production M&I Map inquires).
About the prototype of Phase 2 (Approvals)
Please see Phase 2 Prototype for a description of the design process that resulted in the prototype of the Phase 2 approval process, and for details of how the prototype was constructed.