Prototype URL: https://medcheck.octoconsulting.com
Deployment Instructions: https://github.com/OctoConsulting/18f-ads-pool-3/blob/master/docs/deployment-instructions.md
MedCheck is a responsive web application developed by Octo Consulting Group (Octo) in response to the solicitation released by GSA 18F for Agile Delivery Services (ADS). MedCheck leverages fda.gov APIs and provides analysis of adverse events and recalls of various drugs. Octo's team used a user-centric approach and followed an agile delivery process in delivering the MedCheck application across multiple releases. The key highlights of our approach include:
- Focus on user experience through the creation of user personas, user testing and market surveys
- Use of Scrum to manage the backlog and delivery of the development team
- Use of Kanban for managing the backlog for User Interface and User Experience (UI/UX) and DevOps teams
- Use of docker containers, docker hub and Jenkins to automate continuous integration and delivery
The following diagram outlines our approach for responding to the solicitation and for the continuous delivery of MedCheck.
Upon the release of the solicitation, Octo assembled a project team consisting of experienced agile experts, developers, user experience designers (UX), visual designers (UI), analysts and devops engineers. The team engaged a group of Octo employees to serve as users during the development of the prototype. The designated users team reviewed the FDA APIs and crafted a problem statement that served as the primary scope for the project team ([Scope] (https://github.com/OctoConsulting/18f-ads-pool-3/blob/master/docs/Agile/Octo%2018F%20Problem%20Statement.docx)).
During Spring 0, the project team reviewed the problem statement and analyzed the dataset to understand the API and data at a high level. This analysis was key in guiding the architecture definition and development of initial user experience artifacts (such as personas). An open, modern technology stack was selected and the DevOps team stood up the initial development, integration and production environments.
In addition, the team performed the following activities during this sprint:
- Identified high level features required to meet the needs of the users
- Decomposed the features into user and technical stories that could be completed in a single sprint
- Created a product vision and roadmap for delivery of features in multiple releases ([Roadmap] (https://github.com/OctoConsulting/18f-ads-pool-3/blob/master/docs/Agile/Epic%20Feature%20Story%20Breakdown%20-%20Day%204%20Release%204.JPG))
The prototype was iteratively built using an Agile approach; the development team using Scrum while the UI/UX and DevOps teams tracked their work using Kanban to ensure they stay ahead of the development team. The team initially planned for 3 production releases of the prototype. Features were planned for each Release, and individual stories for each feature were slotted in sprints within each Release ([Agile Docs] (<https://github.com/OctoConsulting/18f-ads-pool-3/tree/master/docs/Agile)). The team made adjustments to the product based on user feedback after each demo to the users. The team also made adjustments to the product during the implementation by collaborating with the users while working within the constraints imposed by the APIs. For example, we proposed an alternate set of features to the users when the FDA API could not provide some of the data needed for a specific features requested.
User stories were documented in a product backlog, with multiple versions reflecting the changing features identified by our users (Product Backlog). The team planned stories to be completed in each sprint, estimating each story using points, and reviewed completed stories with the Product Manager. At the end of each sprint, a product demo was conducted, feedback collected, product deployed to production, and a sprint review and retrospective completed (Agile Docs). All user and design documentation necessary for the execution of the sprint was constantly updated.
The information gathered from users was used to continuously refine the prototype. After every iteration with the user, UX and UI specialists performed heuristic evaluations, and conducted usability tests to refine the wireframes and final product. Throughout the process, the UX/UI team worked closely with the development team to ensure all user interface changes were implemented in the prototype.
The project team captured user feedback in several ways and produced multiple UX/UI artifacts to ensure the prototype was developed in alignment with user needs:
- Met with the user to ensure that the problem statement was fully understood, to discuss desired features, and to prioritize all features
- Created user personas to capture demographics and needs of different users of the prototype ( Personas)
- Distributed an electronic survey for desired features and expected usage of the prototype (User Survey)
- Generated Workflows to document how a user progresses through the prototype ( Workflows)
- Created a basic wireframe and prototype of the homepage to lay a foundation for the prototype (UI Docs)
- Created an information architecture to organize site content and enriched content using visualizations and metadata
Octo implemented the prototype using modern and open technology stacks with a focus on mobile and API first. Node.js and Loopback frameworks were selected as the primary stack for the service layer with Angular.js and Bootstrap serving as the front-end frameworks. Angular.js based front end exchanged data with Loopback based service layer using secure Restful services with json as the primary data exchange format (Technical Stack).
The Karma test framework was used to write test cases for front end and a combination of Mocha, Supertest and Should were used to write test cases for the service layer. All test cases were automatically executed when new code was checked into the repository via a Jenkins hook for GitHub. Once all test cases passed, the Jenkins-based automated build and promotion script deployed the code to the integration server. The DevOps team used Docker and Chef to code the infrastructure, and the prototype was deployed within a Docker container available publicly on Docker Hub. The integration and production environments were deployed on AWS EC2 instances.
Nagios was used to monitor the health of the infrastructure and the deployed prototype code. Automatic email alerts were sent to the administrator when predetermined thresholds on response time, concurrent users, disk usage, or server load are exceeded.
During this sprint, the team performed final field testing to ensure the application met the needs of the users and conducted usability testing with a broader set of Octo employees. The team conducted final security testing to ensure all the security and accessibility needs were met, and made the necessary adjustments. The DevOps team developed final deployment documentation.
During this phase, the team closed out the execution of the prototype by completing the documentation necessary for submitting the solicitation response to the government.
- Evidence to Digital Services Playbook - See Repository for Artifacts
- Criteria A through K – See Attachment E Approach Criteria Evidence for Pool 3
| DSP Play | Team Activities |
|---|---|
| 1. Understand what people need | Conducted user interviews to capture needs and created user personas, Conducted release reviews to validate features after each release, Conducted user testing in-person and through surveys |
| 2. Address the whole experience... | Generated Workflows to document how a user progresses through the prototype, Created a basic wireframe and prototype of the homepage to lay a foundation for the prototype, Created an information architecture to organize content on the site |
| 3. Make it simple and intuitive | Evaluated ten heuristic principles to review the end-to-end user experience, conducted multiple rounds usability test of the prototype |
| 4. Build the services using agile and iterative practices | Conducted development using Scrum while UI/UX and DevOps followed Kanban |
| 5. Structure budgets... | A budget was determined based on the scope and the team stuck to the budget for the initial release. The budget was revised after additional time was allowed |
| 6. Assign one leader... | Mr. Joe Truppo is assigned as the leader of the team and was held accountable for the overall delivery of the prototype |
| 7 Bring in experienced teams | Average experience of each team member is 8 years with each member specializing in multiple roles |
| 8 Choose a modern technology stack | A stack the includes node.js, Loopback.js, Angular.js and Bootstrap was selected with a Restful backend |
| 9 Deploy in a flexible hosting environment | Prototype deployed in AWS, which is a flexible IaaS environment with the ability to adapt and scale as needed |
| 10 Automate testing and deployments | Testing is automated using Karma for front end and Mocha, Should and Supertest for the service layer. Test cases are automatically executed when new code is checked into the repository |
| 11 Manage security and privacy... | Nagios used to monitor the health of the infrastructure and prototype for continuous monitoring. HTTPS/SSL used to encrypt the communications between browser and server |
| 12 Use data to drive decisions | Data collected during each sprint and release (Points considered, Team Velocity, API Capabilities, etc.) is used to work with users and adjust course as needed |
| 13 Default to Open | Technical stack selected is open source and the prototype is developed using open standards such as Restful services and Json. |