Skip to content

TAJ-Tech/open.fda.gov

 
 

Repository files navigation

Iterative/Agile Approach to FDA Challenge Prototype – Pool 1 URL: http://216.84.172.104/drug/event/

1. Identifying the Team

TAJ team (Role and name of individual) for developing the prototype consisted of:

  1. An overall lead as well as Product Manager/Owner – Mr. Anil Subbarao
  2. Visual Designer – Mr. Khaja Raziuddin
  3. User Researcher/Usability Tester – Mr. Shaji Thomas

Also, we had 3 of our own internal employees serve as the SMEs to show and develop the prototype. Our own Systems Administrator, was the 7th member of the team, who helped establish the development and hosting environment.

2. Discussing and deciding the approach

The Team reviewed and discussed the FDA challenge as stated on the FDA web site in deciding the approach. Given the scale and size of this prototype, Kanban/SCRUM hybrid approach was adopted for quick turnarounds. Separate sprints were not adopted for this prototype as everything was accomplished in one development cycle, iteratively. Microsoft Word was sufficient to handle the product backlog tracking. Requirements identified were broken into smaller stories or tasks, and the artifacts needed for executing the project were identified. We also used emails and short phone calls and meetings for communication and conducted daily standup/conference calls to discuss work items, progress and feedback. A daily time capture was mandated for everybody in the team to monitor the time taken for developing the prototype.

3. Identifying the Artifacts needed for the project

The following artifacts were identified for the prototype project Documentation:

  1. Approach document (this document)
  2. Product Backlog/Requirements
  3. High Level Design
  4. Sprint Log (recurring 15 min meeting everyday )
  5. Time tracking at the item level in Product Backlog

Software working prototype URL:

4. Identifying the Requirements (Product Backlog or Stories) and High Level Design

Microsoft Word was used for capture of Product Backlog of stories and tasks for the prototype. The stories and tasks were analyzed and implemented one at a time till the prototype was completed. SME’s feedback were included and reflected in the Development Backlog.

A High Level Design was created and used as a base to build the prototype.

5. Identifying the process and steps needed

An Agile and iterative process was used to identify needs and speed development. Time was recorded for each of the stories and tasks. Immediate feedback was given after testing each new feature for either further improvisation or approval.

6. Daily Standups/conference calls and monitoring progress

Daily conference calls were scheduled using Outlook. As stories and tasks were converted into solutions, developed and tested, the status was updated in the Product Backlog document.

7. Setting up the environment

To get us started quickly, so we could focus on development and the prototype, we mirrored the FDA site (https://github.com/FDA/open.fda.gov explains how mirror the site) and then expanded on the code base to create our own, new prototype. To achieve this, we used both the open.fda.gov and the openFDA website.

8. Designing solutions for stories

We converted each story into a design and then implemented it. The approach kept the design simple so that a separate artifact need not be created for every solution and the High Level Design document suffices. When needed, the design is explained and added to the artifacts.

9. Implementing the design

Designs are implemented in code and tested out based on the solution. The open.fda.gov website was forked and checked out from GitHub and was modified to include a new tab to display Spikes for a given drug query. The following files were modified:

  • _config.yml
  • static/js/api-demo.js
  • _includes/api-demo-drug-event.html

We reused existing code and the UI, including the c3.js library already used by open.fda.gov used for charting.

10. Reviewing and improving the prototype

The team reviewed the prototype, tested functionality and suggested recommendations. Testers acted as proxy users and through their feedback changes to human UI were iteratively made. See “Screen shot.docx” file for supporting documentation.

11. Hosting and the GIT repository

The prototype has been hosted at http://216.84.172.104/drug/event/

The server runs Linux and Jekyll, and the actual software is also developed using node.js, ruby, Javascript and python The code and all the artifacts (including this document) are at the GIT repository

12. Project artifacts

All project artifacts are located in the artifacts folder in the GitHub repository located at: https://github.com/TAJ-Tech/open.fda.gov/tree/master/_artifacts

Releases

No releases published

Packages

No packages published

Languages

  • HTML 46.1%
  • CSS 40.5%
  • JavaScript 13.4%