Functional Requirements - bluecolab/BlueColab_MobileDataViz GitHub Wiki

Functional Requirements

Purpose: Outline what the app should do. Define what is in scope and not in scope.

Project Overview

You have the right to know what's in your water. How can you know your water's safe if you don't know what's in it?

The app presents a solution to this. We present water quality right to your finger tips. It's proof, an example, that ensuring the right to know what's in your water is possible.

The Requirements

Sec 1: Displaying data:
  1. Display the latest water quality information for Choate Pond and Hudson River locations. At the least show: water temperature, dissolved oxygen, pH, salinity, conductivity, and turbidity. For Choate Pond water quality index (WQI) should be shown.
  2. Display a history of the water quality information for Choate Pond and Hudson River locations. At the least show: water temperature, dissolved oxygen, pH, salinity, conductivity, and turbidity. For Choate Pond water quality index (WQI) should be shown.
  3. Display the latest weather data for Choate Pond and Hudson River locations. At the least show: air temperature and air quality index.
Sec 2: Putting context to data:
  1. Presenting a single data point for Sec 1.1 does not provide enough context. Provide a short term history of data points.
  2. Users must understand what the data they see means. What do each of the parameters mean? What effect do they have? What good or bad thresholds do the parameters have?
  3. Different water parameters may correlate with each other. Showing relationships provides context and findings to users. Show the relationships or even lack there of.
  4. Water and weather may correlate with each other. Showing relationships provides context and findings to users. Show the relationships or even lack there of.
Sec 3: Visual Needs:
  1. Colors are a great way of letting users know what data means. Provide context behind the values of water data parameters with color.
  2. We want people to use the app. Create a modern and eye-catching UI. Dark mode even.
Sec 4: Other Needs:
  1. This app is not possible without Blue CoLab. Create a about us section.
  2. More impotently, people created the app. Credit them.
  3. We also use code and data by others. Credit them.
  4. Also, we can't just provide water data. That is boring. Thus ideas to enhance user experience are: access to Blue CoLab Blogs and also wild life in Choate Pond.

There's implicit requirements as well. If we have multiple locations we need a way to switch between them. They will not be listed here.