amaa-team.github.io

Requirements Specification for Project AMAA

---

1.1 Purpose of Product

The purpose of this productivity application is to help people store and keep track of tasks set by the user of the program. We plan to accomplish this by allowing the users to set custom tasks that the application will store and organize for the user. We hope this will help the user have an easier time to keep track of important tasks or events. The application will also encourage the user to complete their tasks by giving motivational quotes based on how successful they are at completing them. We plan to make this program a beneficial addition to people’s planning process so they can accomplish more and be more efficient with their time.

1.2 Scope of Product

The main purpose of the application is to help a user be able to achieve his or her daily goals and by having it all in one place the user can constantly have an idea of how well their day is going. The main problem we are trying to tackle is the frequency with which people are unable to simply complete the things they set out to complete at the start of the day. The application is not an instant fix or a remedy, but it is the best possible way to keep our users accountable to themselves, and that is what we aim at doing with our app. The application provides the user with an interface where he/she can setup their daily goals and the app will provide timely reminders and also provide them with a completion rating at the end of the day, followed by a motivational quote that will be chosen on the basis of their completion rating.

1.3 Acronyms, Abbreviations, Definitions

• Wherever “we” is mentioned, it is defined as the group as the whole and what decisions the group has made. Specific information from specific people will be implicitly noted.

• For outside sources and other information regarding outside information, please see the “References” portion.
  
  

• Definitions:
  • AMAA
    • Alen, Marco, Alex, Anish
    • The first initials of the names of members in the group.
  • Application
    • A format; Desktop-based application
  • JavaFX
    • The library that we will be using in order to implement the GUI portion of the project. We will use the built-in functions that will help create the window, and objects in the window, that the user can interact with.
  • TaskManager
    • The name of the application. TaskMaster is made by AMAA Team.

1.4 References

• Project Site: Learn more about our project!
• Program Repository: Check out the nitty gritty details of our code!
• Project Site Repository: Behind the scenes of our page!
• JavaFX Website: This is the resource we plan to use to make our program look great!

2.1 Context of Product

• Our project will be a desktop program that runs locally on the user’s computer/laptop.

2.2 Domain Model with Description

The domain model above is a general representation of the TaskMaster application. The TaskMaster application relies on the 3 different major parts:

1. User
2. Controller
3. Reminders

The user represents the most “top-level” in the hierarchy. The user has access to the other relative sections, as the user is where the information comes from. Once there is information to store, user input, then it will be sent to the Controller class controller.java

The controller class is what handles the buttons and forms that the user can interact with. It is the bridge between the user and the c<? Storage and reminders work hand-in-hand. Whenever the controller receives input, it is sent to be process by the reminders class. This, then, is stored in the reminders.

On-time reminders is how the user can see how often they are finishing tasks on time.

2.3 Product Functions (general)

• The Taskmaster program will have functionality for the user to add tasks to a list which the program will keep track of. The program will remind users to complete tasks, and will additionally provide encouragement through offering motivational quotes along with the reminders.

2.4 User Characteristics and Expectations

• Our userbase will want organized tasks with added reminders to encourage them to complete these tasks. TaskMaster users only need the most basic computer skills, ability to use a mouse to click on things, and keyboard to type. Users will need to read text in our program to select the correct functions they want and to know what information(s) needs to be input.

2.5 Constraints

• Our program currently has the constraint of only running on devices that have successfully installed JavaFX/OpenFX. This is due to the needed dependencies. See 2.6.

  • This issue is currently being researched on and the team has made the decision of using JavaPackager to create an executable of our file.
    • This issue was primarily due to not using a build tool, such as Maven

2.6 Assumptions and Dependencies

• The TaskMaster program depends heavily on the many .jar files provided by the OpenFX software.
• For the time being, it is the assumed that the user has Java 17+ and some JavaFX version 17+ installed.

3. Functional Requirements

• Please see: User Stories

4.1 External Interface Requirements (User,Hardware, Software, Communications)

• Our program will have a GUI that comes up in a window on the computer screen. There is interaction with the user using a keyboard and mouse to select functions and enter information into the program, which may occur on overlays in our window.
• NF.4.1.1
  • Device must have a display
• NF.4.1.2
  • Devcice must have mouse input
• NF.4.1.3
  • Device must have keyboar input

4.2 Performance Requirements

• The Taskmaster program will be low-impact with regards with performance and will not require many system resources.
  
  • NF.4.2.1
    • Resource efficient to run with other programs
      
  • NF.4.2.2
    • Run on a Windows system (Other OS options are not being planned)
      
  • NF.4.2.3
    • Be storage efficient for data storge

4.3 Design Constraints

The Taskmaster program is designed to be a simple java application to keep track of the information given by the user. The only data that can be accessed is the files within its folder.

• NF.4.3.1
  • The program will only store the data given by the user in reminders and completion record
    
• NF.4.3.2
  • The program will be offline only and save data locally
    
• NF.4.3.3
  • The program will be accessed through a GUI
    
• NF.4.3.4
  • All processes will executed through the application

4.4 Quality Requirements

• Our users need the program to not have any glitches and be reliable to remind them of tasks at the correct times. Being simple to use and easy to learn is also important to make it appeal to many users.
  
  • NF.4.4.1
    • Aesthetic Visual Design that does not strain the eyes.
      
  • NF.4.4.2
    • Basic GUI with only the required buttons for functions (clutter-free).
      
  • NF.4.4.3
    • Continuous reminders at appropriate times until tasks are marked as complete by user.

4.5 Other Requirements

• NF.4.5.1
  • Taskmaster must be simple to use, it is a one size fits all application.
    
• NF.4.5.2
  • Must help users realiably track their usage of time.
    
• NF.4.5.3
  • Quotes and notifications must not flood the users desktop and become counter-productive.

5. Appendices

• Usage of JavaFX / OpenFX documentation can be found here.
  
• Additional user constraints specified in the user stories.