10 Cent Tom System Requirements Document

1. Introduction

This System Requirements Document (SRD) outlines the specifications for the "10 Cent Tom" project, a CRM system designed to support a recycling business in Australia. The system will manage employee information, track payouts, log working hours, and facilitate route planning for waste collection.

2. System Overview

The "10 Cent Tom" CRM system aims to streamline operations for a recycling business by providing tools to manage employees, track their working hours, process payouts, and plan collection routes efficiently.

2a. Product Interpretation and Delivery Boundary

• Domain Descriptors:

  • Employee Management: Manage employee payouts, working hours, and logistics.
  • Logistics Coordination: Coordinate routes and schedules for waste collection.

• What is being built:

  • A CRM system with custom UI for managing employee and logistics operations.
  • Includes Payroll Dashboard, Time Tracking Interface, Route Planning Dashboard, and Authentication.

• Excluded Assumptions:

  • Generic CRM features not related to employee or logistics management.

• Access:

  • Application-owned identity with authentication and authorization for privileged workflow access.

• Behavior Contracts:

  • Manage Employee Payouts: Operations Manager processes payroll monthly.
  • Track Working Hours: Drivers log their working hours through punch in/out.
  • Route and Schedule Management: Operations Manager plans routes weekly.

2b. Page Content and Component Coverage

Payroll Dashboard

• Purpose: Manage employee payouts.
• Components:
  • Employee list with payout details.
  • Payroll processing actions.
  • Error handling for payroll processing issues.

Time Tracking Interface

• Purpose: Track driver working hours.
• Components:
  • Punch in/out functionality.
  • Display of logged hours.
  • Error handling for time tracking issues.

Route Planning Dashboard

• Purpose: Manage routes and driver assignments.
• Components:
  • Route scheduling tools.
  • Driver and van assignment interface.
  • Conflict resolution for scheduling issues.

Authentication

• Purpose: Secure access to the CRM system.
• Components:
  • Sign-up and login forms.
  • Session management.

3. Functional Requirements as Story Points

• As an Operations Manager, I should be able to process monthly payroll to ensure employees are paid accurately. explicit
• As a Driver, I should be able to punch in and out to log my working hours accurately. explicit
• As an Operations Manager, I should be able to plan routes and assign drivers weekly to ensure efficient waste collection. explicit
• As a user, I should be able to sign up, log in, and manage my session to access the CRM securely. required_inference

4. User Personas

• Operations Manager: Oversees employee management and logistics.
• Driver: Collects waste bins and tracks routes and schedules.

5. Core User Flows

Operations Manager

1. Log in to the system.
2. Access the Payroll Dashboard to process payroll.
3. Navigate to the Route Planning Dashboard to plan routes and assign drivers.

Driver

1. Log in to the system.
2. Use the Time Tracking Interface to punch in and out.
3. View assigned routes and schedules.

6. Visuals Colors and Theme

• Primary: #2E7D32 (Green)
• Primary Light: #66BB6A
• Secondary: #FFEB3B (Yellow)
• Accent: #FF5722 (Orange)
• Highlight: #FFC107 (Amber)
• Background: #F5F5F5 (Light Grey)
• Surface: #FFFFFF (White)
• Text: #212121 (Dark Grey)
• Text Muted: #757575 (Grey)
• Border: #BDBDBD (Light Grey)

7. Signature Design Concept

The Payroll Dashboard will feature a clean, intuitive layout with a focus on ease of navigation. The design will use the primary green color to highlight key actions and the secondary yellow for notifications. The interface will be responsive, ensuring usability across devices.

8. Interaction Model & Motion Direction

• Interaction Model: Animated
• Motion Direction: Moderate scroll-triggered reveals and hover transitions will be used to enhance user experience without overwhelming the user.

9. Non-Functional Requirements

• Security: Secure authentication and authorization are required to protect sensitive employee and operational data. required_inference

10. Tech Stack

• Frontend: React for Web
• Backend: Python with FastAPI
• Database: MySQL or MariaDB, using Alembic for migrations
• Local Orchestration: Docker and docker-compose

11. Assumptions and Constraints

• The CRM will focus solely on employee and logistics management.
• The system will not include generic CRM features unrelated to the core functionalities.

12. Glossary

• CRM: Customer Relationship Management
• UI: User Interface
• Operations Manager: The user responsible for managing operations and logistics.
• Driver: The user responsible for collecting waste bins and tracking routes.