BenjaminTham-SIT / INF2001_P4-5

INF2001 Introduction to Software Engineering
0 stars 0 forks source link

[1.6.3] M1 Report Draft 1: Specific Requirements #73

Closed itsalys closed 11 months ago

itsalys commented 12 months ago

About:

M1 report specific requirements describes the logical characteristics of each interface between product and the users.


Goals:


Success - Completion Details:


Allocated Time:

4 days


Start date - End Date:

20/9 - 23/9


Person-in-charge:


Task Status:


Priority:


Notes:

itsalys commented 12 months ago

Work Done:

Completed Functional and Non Functional Requirements (Accessibility, Performance, Safety and Security, Others)

Functional Requirements

FR1: The employee shall view their jobs and workload on the employee landing page. This view should include details about the studio, student and instrument associated with each job (PF2) FR2: The employee shall have the option to view their jobs and workload by week, or month. The weekly view is in the format of 7 days, from 0900 to 2100 on Monday through Friday, and 0800 to 2100 on Saturday and Sunday. The monthly view is in a format of 28 days, 30 days, or 31 days. These do not include public holidays. (PF2) FR3: The employee shall add, edit and delete and submit their availability. By default, this can be done up to 5 weeks before the due date, which is the 19th of every month. By default, the system will assume the employee is available throughout business hours. (PF3)
FR4: The employee shall have the option to add, edit, and delete their job preference. These preferences are the instrument, date and time they prefer to teach each lesson. By default, this can be done up to 5 weeks before the due date, which is the 19th of every month. (PF3) FR5: The manager shall be able to specify the start and due date for employees to submit their availability and preferences. (PF3, PF6) FR6: The employee shall have the option to request to reject job assignments. By default, a job rejection should be submitted 3 days in advance. (PF4) FR7: The employee must provide a reason before the rejection can be submitted. (PF4) FR8: The manager shall be able to specify how far in advance a rejection must be submitted. (PF4, PF6) FR9: The employee shall have the option to cancel jobs. By default, the employee must cancel a job 1 hour prior to the start of the class. (PF5)
FR10: The manager shall have the option to specify how far in advance the employee must cancel a job. (PF5, PF6) FR11: The employees shall have the option to export their workload and jobs into either PDF format, Excel format and PNG format (PF16) FR12: The manager shall view the workload and jobs of employees. These views should include information such as studio, student, instrument and employee for each job. (PF7)
FR13: The manager shall have the option to view the employee's workload and jobs by day, week, month. The manager shall have the option to specify the time blocks to display the employee's workload and jobs in the daily view; 15 min, 30 min or 2 hrs. By default, it is displayed in 15 min time blocks. (PF7)
FR14: The manager shall have the option to filter the employee's workload and jobs by studio or employee (PF7)
FR15: The manager shall create a job and fill in the details such as date, time, student, studio and instrument taught. (PF8) FR16: The manager has the option to edit existing jobs. They can edit the following details: date, time, studio, student, employee, instruments. (PF8) FR17: The manager has the option to cancel jobs. By default, the manager can cancel a job any time prior to the start of the class. (PF8) FR18: The manager shall have the option to specify how far in advance a manager must cancel a job. (PF8, PF6) FR19: The manager shall be able to allocate jobs to employees for each business day within a specific week. (PF9) FR20: The manager shall have the option to view the availability and preferences of employees while allocating jobs. This includes details about their workload, jobs, the available dates and times submitted by the employee and the preferred instrument, dates and times submitted by the employee. By default, the availability and preferences of up to 3 employees will be displayed. (PF9) FR21: The manager shall have the option to publish job allocations. (PF10) FR22: the manager shall have a standby list of employees. The standby list is for each individual job. manager shall allocate another employee from the backup list to take the job. (PF11) FR23: The manager shall have the option to add employees to the standby list for each job during job allocation. The backup list is for each individual job. (PF11) FR24: The manager shall be able to approve or deny job rejections from employees. (PF4) FR25: The manager shall have the option to allocate a new employee to a job that has been rejected. (PF4) FR26: the manager shall have the option to allocate make-up jobs for the employees based on the employee's availability and preferences. (PF12) FR27: The manager shall be able to view the employees with the over 40 working hours on the landing page (PF13) FR28: The manager shall be able to view the employees with the lowest working hours on the landing page (PF13) FR29: The manager shall be able to monitor how often the preferred instrument, dates and times submitted by the employees are fulfilled. The manager shall have the option to filter by instrument, dates and times, or both. (PF14) FR30: The manager shall have the option to export the employee’s workload into either PDF format, Excel format and PNG format (PF16) FR31: The admin shall create employee and manager accounts. (PF15) FR32: The admin shall be able to edit and delete employee and manager accounts. (PF15)

Non-functional Requirements

Accessibility

NFR1: The system shall be compatible with various web browsers (e.g., Chrome, Firefox, Safari) NFR2: The system shall provide multilingual support

Performance

NFR3: Each music school branch must operate on its own independent, monolithic workload management system. NFR4: The system shall respond to user interactions within 2 seconds. NFR5: The system must be capable of supporting concurrent users, ranging from 10-50 users up to a maximum of 250 users NFR6: The system shall handle a minimum of 10,000 workload items concurrently without significant performance degradation. NFR7: The system shall have at least 99% uptime over any given month to ensure uninterrupted access for users.

Safety and Security

NFR8: The system shall provide data recovery capabilities to ensure that data can be restored in case of accidental data loss or system failures. NFR9: The system shall have mechanisms in place for failover and disaster recovery to ensure minimal downtime in case of a system failure or unexpected events. NFR10: All passwords must follow these strong password requirements; minimum of 8 characters in length and consisting of at least 1 uppercase, 1 lowercase, and 1 number.

Others

NFR11: The system's encryption and database design must follow the standards outlined by the Infocomm Media Development Authority (IMDA) Telecommunication and Security Standards and the Cyber Security Agency of Singapore Security-by-Design Framework. NFR12: The system must follow the guidelines and provisions of the Personal Data Protection Act (PDPA).


Repository Commit status:

no commit


Completion Deadline Effect:


Changelog:

[Day/Month/2023] - (details) 22/09/2023 - Completed Functional & Non-functional (Accessibility, Performance, Safety and Security) and Others Requirements


Start Date - End Date:

20/9 - 23/9

claris0911 commented 11 months ago

Work Done:

Completed use case model/diagram and Activity diagram

INF2001 Use Case Diagram - Draft 4.pdf

INF2001 Use Case Diagram - Activity Diagram.pdf


Repository Commit status:

No commit


Completion Deadline Effect:


Changelog:

[Day/Month/2023] - (details) 22/09/2023 - Completed Functional & Non-functional (Accessibility, Performance, Safety and Security) and Others Requirements 23/09/2023 - Completed use case model


Start Date - End Date:

20/9 - 23/9

itsalys commented 11 months ago

Work Done:

Completed Accessibility and User Experience sections of the User Interface Requirements

Accessibility

User Experience


Repository Commit status:

no Commit


Completion Deadline Effect:


Changelog:

[Day/Month/2023] - (details) 22/09/2023 - Completed Functional & Non-functional (Accessibility, Performance, Safety and Security) and Others Requirements 23/09/2023 - Completed use case model 23/09/2023 - Completed Completed Accessibility and User Experience sections of the User Interface Requirements

Claire1202 commented 11 months ago

Completed use case descriptions

Use Case Descriptions Finalised.pdf

2202528 commented 11 months ago

Work Done:

Completed Design and Branding and User Interface sections of User Interface Requirements

Design and Branding

Company Logo:

Image

Colour Palette:

Image

Font Style and Size:

Image

User Interface Requirements

I created 3 wireframes, representing the Manager Dashboard, the Employee Dashboard and for the Employee Job Allocation page.

Manager Dashboard - With Annotations

Image

Manager Dashboard - Without Annotations

Image

Description: This wireframe represents the dashboard of the Manager where the workload of employees would be displayed by employee shifts. The top 3 employees with the least workload and all the staff with a workload of over 40 hours per week would also be displayed in the Dashboard.

Employee Dashboard - With Annotations

Image

Employee Dashboard - Without Annotations

Image

Description: This wireframe represents the dashboard of the Employee where the workload of the employee will be displayed via a calendar, by week or by month. The percentage of how many allocated jobs contained the employee's preferred instrument and preferred timing is also shown.

Employee Job Allocation - With Annotations

Image

Employee Job Allocation - Without Annotations

Image

Description: This wireframe represents the Job Allocation page of the Employee. The Job Allocation page has 3 sub pages, one for the employee's allocated jobs, one for the employee's job availabilities and another for their preferences. This wireframe shows the sub page for the employee's allocated jobs.


Repository Commit status:

No commit


Completion Deadline Effect:


Changelog:

[Day/Month/2023] - (details)

21/09/2023 - Completed Company Logo, Employee Dashboard 22/09/2023 - Completed Colour Palette, Employee Job Allocation 23/09/2023 - Completed Manager Job Allocation, Edited Employee Dashboard and Employee Job Allocation pages Add Annotations and description for Wireframes Edited and Completed "Font Style and Size" section of Design and Branding


Start Date - End Date:

21 September 2023 - 23 September 2023