(PRD): User Timeline Feature

[vinit717]

1. Title

• Project Name: User Timeline Feature
• Date: July 30, 2024
• Author: Vinit Khandal

---

2. Overview

• Objective: Develop a timeline feature to provide super users with a comprehensive track record of all user-related logs.
• Background: Super users need a tool to monitor and track user activities to manage and optimize user engagement and productivity.
• Scope: This feature includes backend storage of logs, frontend UI to display the timeline and relevant status tracking.

---

3. Goals and Objectives

• Primary Goal: Enable super users to view a detailed timeline of user activities and statuses.
• Secondary Goals: Enhance monitoring capabilities to identify inactive or negligent users.

---

4. Requirements

Functional Requirements:

1. User Logs:

• Track user join date to RDS.
• Log start and completion dates of onboarding tasks.
• Log start dates and updates of individual tasks.
• Track the frequency and instances of negligent role assignments (when a user does not update task progress for more than 3 days).

2. User Status Tracking:

• Out of Office (OOO): Track periods when users are out of the office with start and end dates and the reason they give.
• Idle: Track when users do not have active tasks and the duration of this status.
• Active: Track when users have ongoing tasks.
• Onboarding: Track the status of new users who have recently joined.
• Remove: Track the date when user remove from the server

3. UI/UX Requirements:

• Display a chronological timeline of user activities.
• Allow filtering and sorting of logs by date and activity type.

Non-Functional Requirements:

1. Performance:

• The timeline loads quickly.
• Ensure minimal latency in fetching and displaying logs.

2. Security:

• Logs should be accessible only to super users.

Technical Requirements:

1. Backend:

• Use AWS and it's tools(Database).
• Implement API endpoints for different log retrieval.
• Test the whole API with unit and integration testing

2. Frontend:

• Develop a basic UI

Data Requirements:

1. Log Data:

• User ID
• Action type (e.g., join RDS, start task, complete task)
• Timestamp

• Additional metadata (e.g., task details, status changes)

  And will proceed with the current logs that we are using https://github.com/Real-Dev-Squad/website-api-contracts/tree/aa5babcbd710e1bfe218fc6b523f237a769c9021/logs

---

5. User Stories

1. As a super user, I want to see a list of all user activities so that I can monitor user engagement and productivity.
2. As a super user, I want to filter user logs by date range so that I can view specific periods of activity.
3. As a super user, I want to see a complete timeline for the user track record.

---

6. Acceptance Criteria

1. Timeline Display:

• Logs must be displayed in chronological order.
• Timeline must show at least the last 30 days of activity by default.
• Users must be able to filter logs by a custom date range.

2. User Status Indicators:

• Status changes must be clearly indicated on the timeline.
• Different statuses (OOO, idle, active, onboarding) must have distinct visual representations.

3. Role Tracking:

• The system must accurately log and display instances when a user is assigned a negligent role, Idle role, etc.

---

7. Dependencies

• Database infrastructure for storing logs and user status data.

---

[vinit717]

Rough example of timeline UI