feat: enhance documentation with comprehensive use case and architecture details for mobile and web applications
This commit is contained in:
@@ -0,0 +1,154 @@
|
||||
# Use Case Documentation: Krow Web Platform (Admin Panel)
|
||||
|
||||
## 1. Admin Login
|
||||
|
||||
* **Primary Actor:** System Administrator / Operations Manager
|
||||
* **Description:** The secure entry point for accessing the backend management system.
|
||||
* **Preconditions:** User has admin credentials.
|
||||
* **Main Flow:**
|
||||
1. User accesses the Admin URL.
|
||||
2. User enters email and password.
|
||||
3. System verifies credentials.
|
||||
4. **Success:** Redirects to **Admin Dashboard**.
|
||||
5. **Failure:** Returns to Login Screen with error.
|
||||
|
||||
---
|
||||
|
||||
## 2. Dashboard Navigation
|
||||
|
||||
* **Primary Actor:** Admin
|
||||
* **Description:** The central hub for accessing different management modules.
|
||||
* **Preconditions:** User is logged in.
|
||||
* **Main Flow:**
|
||||
1. User views the dashboard summary.
|
||||
2. User selects a module:
|
||||
* **Staff Mgmt:** To approve and manage workers.
|
||||
* **Client Mgmt:** To onboard businesses.
|
||||
* **Operations:** To monitor live events.
|
||||
* **Finance:** To handle money.
|
||||
* **Configuration:** To change system settings.
|
||||
|
||||
---
|
||||
|
||||
## 3. Staff Management
|
||||
|
||||
* **Primary Actor:** Operations Manager
|
||||
* **Description:** The process of validating new staff members.
|
||||
* **Preconditions:** User is in Staff Management module.
|
||||
* **Main Flow:**
|
||||
1. User filters list for "Pending" applications.
|
||||
2. User reviews documents and profile photos.
|
||||
3. **Approve:** Staff becomes "Active" and can work.
|
||||
4. **Reject:** Staff is notified to fix their profile.
|
||||
|
||||
---
|
||||
|
||||
## 4. Client Management
|
||||
|
||||
* **Primary Actor:** Operations Manager
|
||||
* **Description:** Setting up new business accounts.
|
||||
* **Preconditions:** User is in Client Management module.
|
||||
* **Main Flow:**
|
||||
1. User views existing clients.
|
||||
2. User creates a new Business entity.
|
||||
3. User sets up billing details and credit limits.
|
||||
4. User creates the initial Owner account for the client.
|
||||
|
||||
---
|
||||
|
||||
## 5. Live Operations
|
||||
|
||||
* **Primary Actor:** Operations Manager
|
||||
* **Description:** Monitoring real-time activity and solving problems.
|
||||
* **Preconditions:** Events are active.
|
||||
* **Main Flow:**
|
||||
1. User views the Active Events map/list.
|
||||
2. User monitors staff attendance statuses.
|
||||
3. **Issue:** If a problem arises (e.g., no-show), user intervenes.
|
||||
4. **No Issue:** Shift completes normally.
|
||||
|
||||
---
|
||||
|
||||
## 6. Finance & Payroll
|
||||
|
||||
* **Primary Actor:** Finance Manager
|
||||
* **Description:** Processing payments and charging clients.
|
||||
* **Preconditions:** Shifts are completed.
|
||||
* **Main Flow:**
|
||||
1. User reviews completed shifts.
|
||||
2. User resolves any pending disputes.
|
||||
3. User runs the "Payroll Process" to pay staff.
|
||||
4. User generates invoices for clients.
|
||||
5. User sends invoices via email.
|
||||
|
||||
---
|
||||
|
||||
## 7. Configuration
|
||||
|
||||
* **Primary Actor:** Super Admin
|
||||
* **Description:** Managing the system's rules and settings.
|
||||
* **Preconditions:** User has high-level permissions.
|
||||
* **Main Flow:**
|
||||
1. **Skills:** User adds new skills or certificate requirements.
|
||||
2. **Permissions:** User updates what other admins can do.
|
||||
3. **Audit:** User reviews logs for security checks.
|
||||
|
||||
---
|
||||
|
||||
# Use Case Diagram
|
||||
```mermaid
|
||||
flowchart TD
|
||||
subgraph AdminLogin
|
||||
A[Start Admin Panel] --> B[Login Screen];
|
||||
B --> C[Enter Credentials];
|
||||
C --> D{Verify Auth};
|
||||
D -- Success --> E[Admin Dashboard];
|
||||
D -- Failure --> B;
|
||||
end
|
||||
|
||||
subgraph DashboardNavigation
|
||||
E --> F{Select Module};
|
||||
F -- Staff Mgmt --> G[Staff Management];
|
||||
F -- Client Mgmt --> H[Business Clients];
|
||||
F -- Operations --> I[Live Operations];
|
||||
F -- Finance --> J[Payroll & Invoicing];
|
||||
F -- Config --> K[System Configuration];
|
||||
end
|
||||
|
||||
subgraph StaffManagement
|
||||
G --> L[Filter Pending Staff];
|
||||
L --> M[Review Profile & Docs];
|
||||
M --> N{Decision};
|
||||
N -- Approve --> O[Mark Active];
|
||||
N -- Reject --> P[Request Changes];
|
||||
end
|
||||
|
||||
subgraph ClientManagement
|
||||
H --> Q[View Clients];
|
||||
Q --> R[Create New Business];
|
||||
R --> S[Setup Billing/Credit];
|
||||
S --> T[Create Owner Account];
|
||||
end
|
||||
|
||||
subgraph LiveOperations
|
||||
I --> U[View Active Events Map];
|
||||
U --> V[Monitor Attendance];
|
||||
V --> W{Issue Detected?};
|
||||
W -- Yes --> X[Resolve Dispute/Issue];
|
||||
W -- No --> Y[Shift Completed];
|
||||
end
|
||||
|
||||
subgraph Finance
|
||||
J --> Z[View Completed Shifts];
|
||||
Z --> AA[Resolve Disputes];
|
||||
AA --> AB[Process Payroll Run];
|
||||
AB --> AC[Generate Client Invoices];
|
||||
AC --> AD[Send Invoices];
|
||||
end
|
||||
|
||||
subgraph Configuration
|
||||
K --> AE[Manage Skills/Certs];
|
||||
K --> AF[Manage Roles/Permissions];
|
||||
K --> AG[View Audit Logs];
|
||||
end
|
||||
```
|
||||
Reference in New Issue
Block a user