Software Requirements Specification

for

Romage(RMS)

Version 1.0 approved

Prepared by (Salman Tariq, Anas Nasir, Uswa Tahir)

Software System technologies

21-03-2024

Table of Contents

1. Introduction 1

1.1 Purpose 1

1.2 Document Conventions 1

1.3 Intended Audience and Reading Suggestions 1

1.4 Project Scope 1

1.5 References 2

2. Overall Description 2

2.1 Product Perspective 2

2.2 Product Features 3

2.3 User Classes and Characteristics 3

2.4 Operating Environment 3

2.5 Design and Implementation Constraints 3

2.6 User Documentation 4

2.7 Assumptions and Dependencies 4

3. System Features 4

3.1 System Feature 1 4

3.2 System Feature 2 (and so on) 5

4. External Interface Requirements 5

4.1 User Interfaces 5

4.2 Hardware Interfaces 6

4.3 Software Interfaces 6

4.4 Communications Interfaces 6

5. Other Nonfunctional Requirements 7

5.1 Performance Requirements 7

5.2 Safety Requirements 7

5.3 Security Requirements 7

5.4 Software Quality Attributes 7

6. Other Requirements 7

 

Revision History

1. Introduction

   1. Purpose 

This Software Requirements Specification (SRS) document outlines the requirements for the development of a Romage (Roaster Management System RMS), designated for recording employees' clock-in and clock-out records, managing project records, tracking employee’s progress records, and maintaining and updating employee’s information. Also it will have Admin and Employee dashboard access, which will make the project more comprehensive and will set a hierarchy structure to enhance project control and management capabilities. 

2. Document Conventions

The Romage project relies heavily on typographical rules and norms to provide clarity and cohesion. Throughout this work, we use a consistent font family and size, with standard text given in DM Sans and headers and subheadings stylized in the same typeface. The standard text size is 14 pixels, with headings and subheadings set to 60 and 40 pixels, respectively. Additional standards may include the use of calendars and charts to improve reading and comprehension. These norms work together to create something comprehensive and approachable.

3. Intended Audience and Reading Suggestions

This project caters to a diverse range of stakeholders involved with the development, deployment, and utilization of the shift management system. These include developers, project managers, testers, and administrators. All stakeholders should begin with sections of Introduction,Overall Description, System Features, External Interface Requirements, and Other Non-Functional Requirements, respectively. By following this sequence, the stakeholders can efficiently comprehend the project requirements and contribute effectively to its development and deployment.

 

4. Project Scope

RMS is a software solution designed to optimize and organize employee’s shift management, scheduling and attendance tracking within an organization. The purpose of the RMS is to provide organizations with a  platform for managing employee shifts, thereby minimizing scheduling conflicts, reducing administrative overhead, and improving overall operational effectiveness. 

 

The software caters to the needs of businesses operating across different time zones or with varying shift patterns, offering tools for shift creation, employee mapping, attendance tracking, and shift change management.

 

Objectives and goals:

1. Streamline shift management processes: The RMS aims to simplify the task of creating, assigning, and managing employee shifts, reducing manual effort and minimizing errors.

2. Enhance employee satisfaction: By enabling flexible scheduling options, facilitating shift swaps, and providing timely notifications, the RMS seeks to improve employee satisfaction and engagement.

3. Improve operational performance: Through features such as automated shift rotations, configurable breaks, and real-time attendance tracking, the RMS aims to enhance operational efficiency and productivity.

4. Ensure compliance and accuracy: By maintaining accurate attendance records, enforcing shift margins, and supporting customizable settings, the RMS helps organizations adhere to regulatory requirements and internal policies.

5. Responsive UI design: By improving the user experience and making user interaction process more smooth, the RMS provides a user-friendly interface for editing and managing employee shift schedules, configuring breaks, taking leaves and setting up shift rotation schedules.

5. References

• Title: Romage

• Author: Software System

• Version: 1.0

• Date: March 22, 2024

• FigmaDesign:

https://www.figma.com/file/j271BzNcKiZ0Gu2NB5tVfO/RMS?type=design&node-id=104%3A2&mode=design&t=5iIEWk4Pb4Pcq7Vh-1

• Source/Location: The Romage project is designed to be accessible internationally, 

allowing users from diverse geographical locations to utilise its features and functionalities. 

2. Overall Description

   1. Product Perspective

RMS is a standalone software system for revolutionizing the employee scheduling and shift management system. It is not intended to replace existing systems but rather to enhance them by providing advanced functionalities and a more user-friendly interface for managing shift schedules.

 

Traditional employee scheduling methods like data entry using sheets or manual systems often lead to errors and difficulties especially in organizations with complex employee shift patterns and various time zones. In addition, maintaining the records of employees working from home seemed difficult. So, to address these issues, RMS offers automated features with real-time insights.

 

• Product Family:

RMS is a standalone product, but it can be integrated with other systems of the organization like payroll systems, human resource information systems etc. to increase performance, efficiency, collaboration, communication and data synchronization among the various departments.

• Major Components:

The major components of the RMS include:

• User Interface: The front-end interface through which administrators and users interact with the system to create, manage, and view employee schedules.

• Backend System: The core system logic responsible for processing scheduling requests, enforcing business rules, and maintaining data integrity.

• Database: The database component where employee information, shift schedules, attendance records, and configuration settings are stored.

• Communication Module: The module responsible for sending notifications, alerts, and reminders to users regarding upcoming shifts, shift changes, or leave requests.

• Reporting and Analytics: The component that provides insights and reports on workforce utilization, attendance trends, and scheduling efficiency.

2. Product Features

<Summarize the major features the product contains or the significant functions that it performs or lets the user perform. Details will be provided in Section 3, so only a high level summary  is needed here. Organize the functions to make them understandable to any reader of the SRS. A picture of the major groups of related requirements and how they relate, such as a top level data flow diagram or a class diagram, is often effective.>

3. User Classes and Characteristics

<Identify the various user classes that you anticipate will use this product. User classes may be differentiated based on frequency of use, subset of product functions used, technical expertise, security or privilege levels, educational level, or experience. Describe the pertinent characteristics of each user class. Certain requirements may pertain only to certain user classes. Distinguish the favored user classes from those who are less important to satisfy.>

4. Operating Environment

The operating environment of the RMS consists of

 

System Architecture: Client/Server System

Operating system: Windows/Linux/Mac

Database: MY SQL, Microsoft SQL, MongoDb 

Front-End Platform: React Js

Back-End Platform: PHP, Laravel

 

Coding Environment Tools:

 

Database: MY SQL, Microsoft SQL

Front-End: VS Code

Back-End: VS Code, postman

5. Design and Implementation Constraints

<Describe any items or issues that will limit the options available to the developers. These might include: corporate or regulatory policies; hardware limitations (timing requirements, memory requirements); interfaces to other applications; specific technologies, tools, and databases to be used; parallel operations; language requirements; communications protocols; security considerations; design conventions or programming standards (for example, if the customer’s organization will be responsible for maintaining the delivered software).>

6. User Documentation

User documentation of RMS includes:

It may include tooltips, pop-up guides, filter options, select dropdowns and searchable knowledge bases to address user queries and guidance needs in real-time. It will also include demo video for new clients and users to understand the working of the system. System will also have a user guide or user manual with sample images describing briefly about the system usage.   

7. Assumptions and Dependencies

<List any assumed factors (as opposed to known facts) that could affect the requirements stated in the SRS. These could include third-party or commercial components that you plan to use, issues around the development or operating environment, or constraints. The project could be affected if these assumptions are incorrect, are not shared, or change. Also identify any dependencies the project has on external factors, such as software components that you intend to reuse from another project, unless they are already documented elsewhere (for example, in the vision and scope document or the project plan).>

3. System Features

<This template illustrates organizing the functional requirements for the product by system features, the major services provided by the product. You may prefer to organize this section by use case, mode of operation, user class, object class, functional hierarchy, or combinations of these, whatever makes the most logical sense for your product.>

1. System Feature 1

<Don’t really say “System Feature 1.” State the feature name in just a few words.>

3.1.1 Description and Priority

<Provide a short description of the feature and indicate whether it is of High, Medium, or Low priority. You could also include specific priority component ratings, such as benefit, penalty, cost, and risk (each rated on a relative scale from a low of 1 to a high of 9).>

3.1.2 Stimulus/Response Sequences

<List the sequences of user actions and system responses that stimulate the behavior defined for this feature. These will correspond to the dialog elements associated with use cases.>

3.1.3 Functional Requirements

<Itemize the detailed functional requirements associated with this feature. These are the software capabilities that must be present in order for the user to carry out the services provided by the feature, or to execute the use case. Include how the product should respond to anticipated error conditions or invalid inputs. Requirements should be concise, complete, unambiguous, verifiable, and necessary. Use “TBD” as a placeholder to indicate when necessary information is not yet available.>

 

<Each requirement should be uniquely identified with a sequence number or a meaningful tag of some kind.>

 

REQ-1:

REQ-2:

2. System Feature 2 (and so on)

4. External Interface Requirements

   1. User Interfaces

      1. Login Interface:

 

• This interface allows users to login securely to the system.

• It will include fields for entering usernames and passwords.

• A button for submitting login credentials and entering the system will be provided.

• Error message display standards will be implemented to inform users of login failures or  

incorrect credentials.

 

2. Admin Interface:

 

1. Dashboard

   1. The dashboard interface will serve as the main part for administrators and provide an overview of relevant information.

   2. A calendar representation of shifts will be displayed.

   3. Standard buttons and functions, such as navigation and displaying specific duration data, will be accessible.

   4. Screen layout constraints will ensure that key information is prominently featured and accessible.

2. Shifts

   1. This interface will serve as a source of shift related information.

   2. It will have buttons for navigation and functions.

   3. It will have a button for adding new shifts.

   4. It will have a form for shift credentials.

3. Attendance

   1. This interface will have employee’s attendance related information, like attendance list, etc.

   2. It will  have buttons for navigation as well.

4. Users

   1. This interface will have users related information for all types of users, like administrators and employees.

   2. It will have a button to create a new user.

   3. It will have a form pop up box for creating new users.

   4. It will have a button to edit user information for all types of users.

   5. It will have a button to delete user credentials.

3. Employee interface:

 

1. Dashboard

   1. This interface will serve as it will have information related to specific employee (employees own information only) attendance information.

   2. It will have charts for prominent display of information.

   3. It will have filters to check specific duration’ information.

2. Timetable

   1. This interface will have timetable related information.

   2. It will have a calendar to show the shift's timetable.

   3. It will have buttons to view the calendar in different aspects, like week and month, etc.

3. Attendance

   1. This interface will have attendance related information about employees.

   2. It will have information like employee’s total leaves, paid leaves, unpaid leaves, etc.

   3. It will have a button for requesting leave that has a form.

   4. It will have an attendance overview data table.

   5. It will have buttons for employees to clock in and clock out.

   6. It will have buttons for filter attendance overview to All, Presents, Half Day, etc.

2. Hardware Interfaces

<Describe the logical and physical characteristics of each interface between the software product and the hardware components of the system. This may include the supported device types, the nature of the data and control interactions between the software and the hardware, and communication protocols to be used.>

3. Software Interfaces

<Describe the connections between this product and other specific software components (name and version), including databases, operating systems, tools, libraries, and integrated commercial components. Identify the data items or messages coming into the system and going out and describe the purpose of each. Describe the services needed and the nature of communications. Refer to documents that describe detailed application programming interface protocols. Identify data that will be shared across software components. If the data sharing mechanism must be implemented in a specific way (for example, use of a global data area in a multitasking operating system), specify this as an implementation constraint.>

4. Communications Interfaces

<Describe the requirements associated with any communications functions required by this product, including e-mail, web browser, network server communications protocols, electronic forms, and so on. Define any pertinent message formatting. Identify any communication standards that will be used, such as FTP or HTTP. Specify any communication security or encryption issues, data transfer rates, and synchronization mechanisms.>

5. Other Nonfunctional Requirements

   1. Performance Requirements

<If there are performance requirements for the product under various circumstances, state them here and explain their rationale, to help the developers understand the intent and make suitable design choices. Specify the timing relationships for real time systems. Make such requirements as specific as possible. You may need to state performance requirements for individual functional requirements or features.>

2. Safety Requirements

<Specify those requirements that are concerned with possible loss, damage, or harm that could result from the use of the product. Define any safeguards or actions that must be taken, as well as actions that must be prevented. Refer to any external policies or regulations that state safety issues that affect the product’s design or use. Define any safety certifications that must be satisfied.>

3. Security Requirements

<Specify any requirements regarding security or privacy issues surrounding use of the product or protection of the data used or created by the product. Define any user identity authentication requirements. Refer to any external policies or regulations containing security issues that affect the product. Define any security or privacy certifications that must be satisfied.>

4. Software Quality Attributes

<Specify any additional quality characteristics for the product that will be important to either the customers or the developers. Some to consider are: adaptability, availability, correctness, flexibility, interoperability, maintainability, portability, reliability, reusability, robustness, testability, and usability. Write these to be specific, quantitative, and verifiable when possible. At the least, clarify the relative preferences for various attributes, such as ease of use over ease of learning.>

6. Other Requirements

<Define any other requirements not covered elsewhere in the SRS. This might include database requirements, internationalization requirements, legal requirements, reuse objectives for the project, and so on. Add any new sections that are pertinent to the project.>

Appendix A: Glossary

<Define all the terms necessary to properly interpret the SRS, including acronyms and abbreviations. You may wish to build a separate glossary that spans multiple projects or the entire organization, and just include terms specific to a single project in each SRS.>

Appendix B: Analysis Models

<Optionally, include any pertinent analysis models, such as data flow diagrams, class diagrams, state-transition diagrams, or entity-relationship diagrams.>

Appendix C: Issues List

< This is a dynamic list of the open requirements issues that remain to be resolved, including TBDs, pending decisions, information that is needed, conflicts awaiting resolution, and the like.>