Page 1 of 7
System Requirements Document for TWHR
1. Introduction
This document outlines the system requirements for the TWHR project, a niche HR and compliance micro-SaaS platform tailored for micro-SMEs in Malaysia. The platform aims to address the specific HR and compliance needs of small businesses, focusing on leave and overtime tracking, compliance checklist management, and applicant tracking for niche roles.
2. System Overview
2a. Product Interpretation and Delivery Boundary
The TWHR project is designed to provide a micro-SaaS solution for HR and compliance management, specifically targeting micro-SMEs in Malaysia. The platform will include the following key components:
- Leave and Overtime Tracker: Focused on managing leave balances, overtime approvals, and payroll exports in compliance with Malaysian labor laws, including public holidays and EPF/SOCSO integration points.
- Compliance Checklist Tracker: Provides recurring checklists for hygiene checks, temperature logs, and SSM/tax deadlines, with photo proof and audit trails for F&B SMEs.
- Simple Applicant Tracker: Centralizes CVs, interview notes, and recruitment status for niche roles, such as retail and call-center staff.
Excluded assumptions include generic HR platform features not specific to micro-SMEs and enterprise-level compliance management tools.
Access is application-owned, with a custom UI and background automation. The platform requires authentication for persistent identity access and authorization for privileged workflow access.
Page 2 of 7
2b. Source Content Inventory
No explicit content sources were provided. Default assumptions will be used where necessary.
2c. Page Content and Component Coverage
Leave and Overtime Tracker Page
- Information: Employee leave balances, overtime hours, payroll export options.
- Actions: Approve/reject leave requests, approve overtime, export payroll data.
- Components: Leave balance display, overtime approval form, payroll export button.
- States: Loading, success, error, empty (no leave requests).
Compliance Checklist Tracker Page
- Information: Checklist templates, compliance criteria, audit trails.
- Actions: Schedule compliance tasks, upload photo proof, view audit history.
- Components: Checklist scheduler, photo upload interface, audit trail viewer.
- States: Loading, success, error, empty (no scheduled tasks).
Simple Applicant Tracker Page
- Information: Candidate CVs, interview notes, recruitment status.
- Actions: Add new candidate, update interview notes, change recruitment status.
- Components: Candidate profile viewer, interview notes editor, status updater.
- States: Loading, success, error, empty (no candidates).
Page 3 of 7
Authentication Page
- Information: User credentials, session status.
- Actions: Sign-up, login, logout.
- Components: Sign-up form, login form, session management.
- States: Loading, success, error.
3. Functional Requirements as Story Points
- As a Micro-SME HR Manager, I should be able to track employee leave balances and approve overtime to ensure compliance with Malaysian labor laws.
explicit
- As a Micro-SME HR Manager, I should be able to export payroll data to streamline payroll processing.
explicit
- As an F&B Compliance Officer, I should be able to schedule compliance checklists and upload photo proof to maintain an audit trail.
explicit
- As an F&B Compliance Officer, I should be able to view and manage compliance tasks to ensure food safety and operations compliance.
explicit
- As a Recruitment Manager, I should be able to add new candidates and update their recruitment status to centralize the recruitment process.
explicit
- As a Recruitment Manager, I should be able to view candidate profiles and interview notes to track the recruitment process.
explicit
- As a user, I should be able to sign up, log in, and manage my session to access the platform securely.
required_inference
4. User Personas
- Micro-SME HR Manager: Manages HR tasks for micro-SMEs, focusing on leave and overtime tracking.
- F&B Compliance Officer: Manages compliance tasks for F&B SMEs, focusing on hygiene and operations compliance.
- Recruitment Manager: Manages recruitment tasks for niche roles, focusing on candidate tracking and status updates.
5. Core User Flows
Page 4 of 7
Micro-SME HR Manager Flow
- Log in to the platform.
- Access the Leave and Overtime Tracker page.
- Review leave requests and approve/reject them.
- Approve overtime hours.
- Export payroll data.
F&B Compliance Officer Flow
- Log in to the platform.
- Access the Compliance Checklist Tracker page.
- Schedule compliance tasks.
- Upload photo proof for completed tasks.
- Review audit trails.
Recruitment Manager Flow
- Log in to the platform.
- Access the Simple Applicant Tracker page.
- Add new candidates and update their profiles.
- Update interview notes and recruitment status.
Page 5 of 7
6. Visuals Colors and Theme
- Primary: #007BFF (Blue)
- Primary Light: #66B2FF
- Secondary: #6C757D (Gray)
- Accent: #28A745 (Green)
- Highlight: #FFC107 (Yellow)
- Background: #F8F9FA (Light Gray)
- Surface: #FFFFFF (White)
- Text: #212529 (Dark Gray)
- Text Muted: #6C757D (Gray)
- Border: #DEE2E6 (Light Gray)
7. Signature Design Concept
The Leave and Overtime Tracker page will feature a clean and intuitive layout with a focus on clarity and ease of use. The primary color, blue, will be used for headings and key action buttons, providing a sense of trust and professionalism. The page will include a responsive header with navigation links to other sections of the platform and a footer with contact information and support links. The design will be minimalistic, with ample white space to enhance readability and focus on the content.
Page 6 of 7
8. Interaction Model & Motion Direction
The interaction model for the Leave and Overtime Tracker page will be "static," prioritizing layout clarity and minimal motion. Hover transitions will be used for interactive elements to provide feedback, and spring physics will be applied to buttons for a polished user experience. The design will focus on task completion and data presentation, avoiding unnecessary decorative motion.
9. Non-Functional Requirements
- The platform must ensure data security and privacy, complying with Malaysian data protection regulations.
required_inference
- The system should be scalable to accommodate up to 50 users per micro-SME.
required_inference
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 platform will focus on micro-SMEs in Malaysia, specifically targeting HR and compliance needs.
- The system will not include generic HR platform features or enterprise-level compliance tools.
Page 7 of 7
12. Glossary
- Micro-SME: Micro, Small, and Medium Enterprises
- EPF: Employees Provident Fund
- SOCSO: Social Security Organization
- SSM: Companies Commission of Malaysia
This document provides a comprehensive overview of the TWHR project requirements, ensuring that all necessary functionalities and constraints are clearly defined for successful implementation.
No comments yet. Be the first!