Inner-Facilities System Requirements Document

1. Introduction

The "Inner-Facilities" project aims to develop a comprehensive Facilities Management System tailored for a commercial office tower. This system will streamline the reporting, management, and resolution of facility-related issues through distinct user interfaces for tenants, operations staff, and technicians.

2. System Overview

The Inner-Facilities system is designed to enhance the efficiency of facility management by providing a unified platform that caters to different user roles. The system will include:

• Tenant Portal: Allows tenants to report issues, upload photos, and receive updates on the progress of their reported issues.
• Operations Dashboard: Enables dispatchers to view, triage, and assign reported issues to technicians.
• Technician View: Provides technicians with a work-order interface to manage tasks, update statuses, log inventory usage, and obtain tenant sign-off.

The system will be hosted as a single application supporting multiple user logins, ensuring seamless communication and task management across all user roles.

3. Functional Requirements

• As a Tenant, I should be able to report facility issues with photo uploads.
• As a Tenant, I should receive updates as the task progresses.
• As a Tenant, I should be able to communicate directly with technicians.
• As a Dispatcher, I should be able to view a master queue of incoming issues.
• As a Dispatcher, I should be able to triage the urgency of issues.
• As a Dispatcher, I should be able to assign issues to technicians.
• As a Technician, I should be able to view my assigned tasks.
• As a Technician, I should be able to update task status to 'In Progress' or 'Completed'.
• As a Technician, I should be able to log inventory parts used.
• As a Technician, I should be able to collect a tenant sign-off signature.

4. User Personas

• Tenant: Individuals or businesses occupying the office spaces who report facility issues.
• Dispatcher: Operations staff responsible for managing and assigning reported issues.
• Technician: Personnel tasked with resolving reported issues and maintaining facilities.

5. Core User Flows

• Tenant reports issue -> uploads photo -> receives task updates -> communicates with technician.
• Dispatcher views issue queue -> triages issue urgency -> assigns issue to technician.
• Technician views assigned tasks -> updates task status -> logs inventory usage -> collects tenant sign-off.

6. Visuals Colors and Theme

• primary: #0047AB (deep blue)
• primary_light: #5A9BD5 (light blue)
• secondary: #FF6F61 (coral)
• accent: #FFD700 (gold)
• highlight: #FFA500 (orange)
• bg: #F4F4F9 (light grey)
• surface: rgba(255, 255, 255, 0.9)
• text: #333333 (dark grey)
• text_muted: #777777 (medium grey)
• border: rgba(0, 71, 171, 0.2)

7. Signature Design Concept

The Inner-Facilities homepage will feature an interactive 3D office tower model using @react-three/fiber. Users can click on different floors to view reported issues and their statuses. As users hover over the model, floors will illuminate, and clicking will zoom into that floor, displaying detailed issue reports and technician assignments. This immersive experience will make navigation intuitive and engaging, providing a clear visual representation of facility management activities.

8. Interaction Model & Motion Direction

The landing page will employ a "parallax" interaction model, with layered depth effects as users scroll. The 3D office tower will be the focal point, with smooth transitions and animations triggered by user interactions. Internal pages will adopt a "static" model for clarity and efficiency, focusing on task management and reporting.

9. Non-Functional Requirements

• The system must support concurrent user sessions for tenants, dispatchers, and technicians.
• It should ensure data security and privacy for all user interactions and data storage.
• The application must be responsive and accessible on both desktop and mobile devices.

10. Tech Stack

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

11. Assumptions and Constraints

• The system will be deployed in a commercial office tower environment, requiring robust network connectivity.
• User interfaces must be intuitive and require minimal training for effective use.
• The system should integrate with existing facility management tools if necessary.

12. Glossary

• Tenant: An individual or business that occupies office space within the tower.
• Dispatcher: Operations staff responsible for managing facility issues.
• Technician: Personnel responsible for resolving facility issues.
• Triage: The process of determining the priority of issues based on urgency.