Cedar-Cleaning System Requirements Document

1. Introduction

The Cedar-Cleaning project aims to develop a comprehensive CRM system tailored for a cleaning business. This system will include functionalities for job tracking and scheduling, enhancing operational efficiency and customer satisfaction.

System Status

The Cedar-Cleaning CRM system is currently in a pre-resolution state, managed by the API supervisor. This status indicates that the system is undergoing final checks and adjustments before full deployment. The API supervisor is responsible for ensuring all components are functioning correctly and meeting the specified requirements.

2. System Overview

The Cedar-Cleaning CRM system is designed to streamline the management of cleaning services, focusing on customer relationship management, job tracking, and scheduling. The system will provide an intuitive interface for managing client information, scheduling cleaning jobs, and tracking job progress.

3. Functional Requirements as Story Points

• As a Business Owner, I should be able to manage customer profiles to maintain up-to-date contact and service information.
• As a Scheduler, I should be able to create, update, and delete cleaning job schedules to efficiently allocate resources.
• As a Cleaner, I should be able to view my assigned jobs and update their status to keep the team informed.
• As a Business Owner, I should be able to track job progress in real-time to ensure timely completion and customer satisfaction.
• As a Scheduler, I should be able to assign cleaners to jobs based on availability and skill set to optimize service delivery.
• As a Customer, I should be able to receive notifications about upcoming cleaning appointments to stay informed.

4. User Personas

• Business Owner: Manages overall operations, customer relationships, and business growth.
• Scheduler: Responsible for creating and managing job schedules and assigning cleaners.
• Cleaner: Executes cleaning jobs and updates job status.
• Customer: Receives cleaning services and interacts with the business for scheduling and feedback.

5. Core User Flows

• Business Owner updates customer profiles -> Scheduler creates job schedules -> Cleaner views and updates job status -> Business Owner tracks job progress.
• Scheduler assigns jobs to Cleaners -> Cleaners receive job notifications -> Cleaners update job completion -> Customers receive job completion notifications.

6. Visuals Colors and Theme

• primary: #2E8B57 (Sea Green)
• primary_light: #66CDAA (Medium Aquamarine)
• secondary: #4682B4 (Steel Blue)
• accent: #FFD700 (Gold)
• highlight: #FF4500 (Orange Red)
• bg: #F5FFFA (Mint Cream)
• surface: #FFFFFF (White)
• text: #2F4F4F (Dark Slate Gray)
• text_muted: #696969 (Dim Gray)
• border: #D3D3D3 (Light Gray)

7. Signature Design Concept

The Cedar-Cleaning homepage will feature an interactive "Cleaning Journey" animation. Users will see a virtual cleaning schedule where icons representing cleaning jobs move along a timeline. As users hover over each icon, detailed job information will pop up, and clicking will expand the job details further. This interactive timeline will be built using motion/react for smooth animations and transitions, providing an engaging and informative experience.

Landing Hero Motion Brief

The landing hero will depict a day in the life of a cleaning business. Icons representing cleaning tools and schedules will animate across the screen, illustrating the transformation from a messy space to a clean, organized environment. This animation will loop every 10 seconds, using motion/react to ensure smooth transitions and interactions. The animation will pause on hover to allow users to explore details.

8. Interaction Model & Motion Direction

• Intended Interaction Model: Animated
• The landing page will feature moderate scroll-triggered reveals and hover transitions, enhancing user engagement without overwhelming them.
• Each section of the landing page will have a distinctive core mechanic, such as morphing SVGs or scroll-linked reveals, to maintain user interest and convey information effectively.

9. Non-Functional Requirements

• The system must be responsive and accessible across various devices and screen sizes.
• The CRM must ensure data security and privacy, adhering to relevant regulations.
• The system should support high availability and reliability to minimize downtime.

10. Tech Stack

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

11. Assumptions and Constraints

• The system will primarily serve the UAE market, considering local business practices and regulations.
• The CRM will integrate with existing tools and platforms used by cleaning businesses.
• The system will be designed to scale with the business as it grows.

12. Glossary

• CRM: Customer Relationship Management
• Scheduler: A role responsible for managing job schedules and assignments.
• Cleaner: A role responsible for executing cleaning jobs.
• Job Tracking: Monitoring the progress and status of cleaning jobs.
• Scheduling Tool: A feature that allows for the planning and allocation of cleaning jobs.