proud-an System Requirements Document

1. Introduction

The project "proud-an" aims to develop a comprehensive IT asset management system. This system will facilitate efficient tracking, management, and reporting of IT assets within an organization. The system will incorporate a multiroles workflow to accommodate different user roles and their specific functionalities.

2. System Overview

The proud-an IT asset management system is designed to streamline the management of IT assets, ensuring accurate tracking, maintenance, and reporting. The system will support multiple user roles, each with distinct permissions and workflows, to enhance operational efficiency and security.

3. Functional Requirements as Story Points

• As an Admin, I should be able to add, update, and delete IT assets in the system.
• As an Admin, I should be able to assign roles and permissions to different users.
• As a User, I should be able to view the list of IT assets assigned to me.
• As a User, I should be able to request maintenance or support for an asset.
• As a Manager, I should be able to approve or reject asset requests from users.
• As a Manager, I should be able to generate reports on asset usage and status.
• As a Technician, I should be able to update the status of maintenance tasks.
• As a Technician, I should be able to log details of repairs and maintenance activities.

4. User Personas

• Admin: Responsible for managing the overall system, including user roles and asset records.
• User: Regular employee who uses IT assets and can request support or maintenance.
• Manager: Oversees asset requests and approvals, and generates reports.
• Technician: Handles maintenance and repair tasks for IT assets.

5. Core User Flows

• Admin logs in -> manages user roles -> updates asset records.
• User logs in -> views assigned assets -> requests maintenance.
• Manager logs in -> reviews asset requests -> approves/rejects requests -> generates reports.
• Technician logs in -> views maintenance tasks -> updates task status -> logs repair details.

6. Visuals Colors and Theme

• primary: #007BFF (a bright blue for brand identity)
• primary_light: #66B2FF (a lighter blue for hover states)
• secondary: #6C757D (a neutral grey for supporting elements)
• accent: #28A745 (a green for call-to-action buttons)
• highlight: #FFC107 (a yellow for notifications and alerts)
• bg: #F8F9FA (a light grey for the background)
• surface: #FFFFFF (white for cards and panels)
• text: #212529 (a dark grey for primary text)
• text_muted: #6C757D (a lighter grey for secondary text)
• border: #DEE2E6 (a subtle grey for borders)

7. Signature Design Concept

The homepage of proud-an will feature an interactive "Asset Lifecycle Journey" animation. Users will see a digital representation of an IT asset traveling through various stages: acquisition, deployment, maintenance, and decommissioning. Each stage will be interactive, allowing users to click and explore detailed information about processes and responsibilities. The animation will be built using motion/react for smooth transitions and interactions.

Landing Hero Motion Brief

The landing hero will depict an IT asset (e.g., a laptop) being acquired, configured, used, maintained, and finally retired. The animation will loop every 10 seconds, showing the transformation of the asset through each stage. Users can hover over each stage to see additional details and statistics. The animation will adapt to different screen sizes, ensuring a seamless experience on all devices.

8. Interaction Model & Motion Direction

The landing page will use an "animated" interaction model, featuring scroll-triggered reveals and hover transitions. Key elements will have spring physics for a polished feel. Internal pages will maintain a "static" interaction model for clarity and ease of use.

9. Non-Functional Requirements

• The system must support concurrent users without performance degradation.
• Data integrity and security must be maintained at all times.
• The system should be scalable to accommodate future growth.

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
• Server-side Orchestration: Kubernetes

11. Assumptions and Constraints

• The system will be deployed in an environment with reliable internet connectivity.
• Users will have access to modern web browsers.
• The system will comply with relevant data protection regulations.

12. Glossary

• IT Asset: Any hardware or software owned by the organization.
• Multiroles Workflow: A system feature that supports different user roles with specific permissions and workflows.
• Admin: A user with the highest level of control over the system.
• User: An employee who uses IT assets.
• Manager: A user who oversees asset management processes.
• Technician: A user responsible for maintaining IT assets.