Skip to content

Requirements

Jump to bottom
fkucuk edited this page Oct 23, 2016 · 23 revisions

FAT App: Requirements Document

WARNING

This document is outdated. A new version is available here: Requirements

Note: The (??) sign means that I have question to the customer about that matter. I've gathered the questions on the Interview Questions page.

Document Status: Initial

I. Introduction

This document contains system requirements for Fat App. These requirements have been derived from:

  • the project description document provided by the instructor.
  • the interview made with the instructor who acted as the customer

a. Scope of the Product

The main purpose of this application is to track food consumption and physical activities of an individual in order them to gain insight into their fitness.

II. General Description

The project description provided by the customer is in the docs folder. You can view it here.

III. Specific Requirements

a. User Requirements

  1. Registration
1.1. The user must register to the system to use it

1.2 The use must provide the following information to register: Date of birth, gender, height, weight

1.5 Won't we need other information: Name, surname? (??)

1.4 Goals of the user is optional during registration (desired weight, nutrition etc.) (??)
  1. Updating Weight
2.1 User can update his/her weight.

2.2 The update moment (day | time) must be recorded.

2.3 The user can view his/her previous recordings (through timeline).
  1. Entering Consumed Food Information
3.1 User can enter the consumed food and its quantity via searching from the data provided by the USDA Api.

3.2 The application must store this data, and the record moment.

3.3 The user can modify this data later on. (??)

3.4 The user can enter free data providing the required information (nutritional data) (??)

3.5 The user can enter past data.(??)
  1. Entering Activity Information
4.1 The user can enter his/her activity by selecting from the list provided nutristrategy.com.

4.2 This information must be recorded.

4.3 The user can modify this data later. (??)

4.4 The user can enter free data providing the required information (calories burnt) (??) 

4.5 The user can enter past data. (??)
  1. BMI
5.1 The application must calculate the BMI according to the data user provided by the following formula (BMI = Mass(kg) / Height(m)<sup>2</sup>)

5.2 The BMI must be updated as the user updates his/her weight information.
  1. Timeline
6.1 The application must keep a timeline of the data user provided.

6.2 Timeline must contain following information: activities, food.

6.3 Timeline can be viewed daily, weekly or monthly.

6.4 Timeline must be limitless. No retention. (??)
  1. Recommendations

The app can recommend following

7.1 Starting daily goal. Daily activity and/or food consumption. (??)

7.2 Can warn the user to make activity or consume less (??)
  1. Reports
8.1 What kind of user reports are expected?  (??)

8.2 Do we need reports for the admin(s)? Number of users, users' demography, etc.  (??)
  1. Admin Panel
9.1 In the project details file, nothing about an admin panel is mentioned. Don't we need an admin panel? (eg. Delete user, suspend user, reset user's password?) (??)

III. System Requirements

  1. How many client users expected? (??)

  2. Are there any SLAs? (eg. Search must not take more than 3 seconds?) (??)

IV. Interface Requirements

Mockaps are available here.

Clone this wiki locally