System Requirements Document (SRD) for shiny-employee

1. Introduction

The shiny-employee project is a fully offline Employee Physical Examination Mobile App designed to streamline employee health assessments. This app will operate without internet dependency, ensuring data security and accessibility in remote or low-connectivity environments. The app will be developed using Flutter for Android-first deployment, with SQLite as the local database. The architecture will be clean, scalable, and modular to support future enhancements.

This document outlines the system requirements, functional and non-functional specifications, user personas, design concepts, and technical stack for the shiny-employee project. It has been tailored to meet the needs of Renish Amipara and the Indian context, including locale-specific considerations such as date formats (DD/MM/YYYY) and currency (INR) where applicable.

2. System Overview

The shiny-employee app is a production-level mobile application aimed at simplifying the process of employee health assessments. It will allow users to manage employee data, record medical history, conduct physical and vision examinations, and generate detailed health reports. The app will function entirely offline, storing all data locally on the device. Key features include:

• Comprehensive employee management.
• Modules for medical history, physical examination, vision tests, and systemic examination.
• PDF report generation with sharing and printing capabilities.
• Robust offline capabilities, including database backup and restore.

The app is designed to be user-friendly, secure, and efficient, catering to organizations in India that require reliable health assessment tools for their workforce.

3. Functional Requirements

Core Functionalities:

• As a User, I should be able to add, edit, and delete employee profiles.
• As a User, I should be able to store employee details such as name, DOB, age, gender, department, company, and address.
• As a User, I should be able to record medical history, including past illnesses, family history, and addictions.
• As a User, I should be able to conduct physical examinations, capturing height, weight, BMI (auto-calculated), pulse, BP, SPO2, and temperature.
• As a User, I should be able to perform vision tests for both eyes, including distant, near, and color vision.
• As a User, I should be able to document systemic examinations for cardiovascular, respiratory, gastrointestinal, and nervous systems.
• As a User, I should be able to generate PDF reports in a predefined format.
• As a User, I should be able to save reports locally and share them via WhatsApp or print them.
• As a User, I should be able to store all data locally without internet dependency.
• As a User, I should be able to back up and restore the database.

4. User Personas

1. Admin

• Role: Manages the app, oversees data entry, and generates reports.
• Needs: Easy navigation, secure data storage, and reliable backup/restore functionality.

2. Medical Examiner

• Role: Conducts physical and vision examinations, records medical history, and generates reports.
• Needs: Intuitive forms, accurate calculations (e.g., BMI), and quick access to employee data.

3. IT Support

• Role: Handles database backup, restore, and troubleshooting.
• Needs: Robust offline capabilities, error handling, and clear documentation.

5. Visuals Colors and Theme

The shiny-employee app will feature a professional yet approachable design. The color palette is tailored to evoke trust and clarity while maintaining a modern aesthetic.

Color Palette:

• Background: #F4F4F9 (Light Gray)
• Surface: #FFFFFF (White)
• Text: #333333 (Dark Gray)
• Accent: #FF6F3C (Vibrant Orange)
• Muted Tones: #B0BEC5 (Soft Blue-Gray)

This palette ensures readability and a clean interface, suitable for medical and professional environments.

6. Signature Design Concept

Interactive Health Dashboard with Animated Metrics

The home page of the shiny-employee app will feature an interactive health dashboard. Users will be greeted with a dynamic, animated interface that displays key metrics such as the number of employees examined, pending reports, and backup status.

• Animations: Circular progress bars will animate to show completion percentages for tasks like "Reports Generated" or "Examinations Completed."
• Transitions: Smooth transitions between modules, with subtle zoom-in effects when selecting an employee profile.
• Micro-Interactions: Hover effects on buttons and icons, with slight color shifts to the accent orange (#FF6F3C).
• Unique Element: A 3D rotating model of a stethoscope on the dashboard, symbolizing the app's focus on health assessments.

This design will make the app visually engaging and provide a memorable first impression.

7. Non-Functional Requirements

• Performance: The app must load within 2 seconds and handle up to 10,000 employee records without lag.
• Scalability: The architecture should support future integration with online synchronization.
• Security: All data must be encrypted and stored securely on the device.
• Usability: The app should be intuitive and require minimal training for users.
• Compatibility: The app must run on Android devices with API level 21 (Lollipop) and above.
• Reliability: The app should function seamlessly in offline mode, with robust error handling for database operations.

8. Tech Stack

Frontend:

• Framework: Flutter (Android-first)
• Language: Dart

Backend:

• Language: Python
• Framework: FastAPI (for future online sync)

Database:

• Primary: SQLite (sqflite plugin for Flutter)
• Backup/Restore: JSON or CSV export/import

Tools:

• PDF Generation: Dart PDF library
• Version Control: Git
• Containerization: Docker (for development environment)

9. Assumptions and Constraints

Assumptions:

• The app will be used primarily in India, so date formats will follow DD/MM/YYYY.
• Users will have basic familiarity with mobile apps.
• Devices will have sufficient storage for local database operations.

Constraints:

• The app must function entirely offline, with no reliance on external servers.
• SQLite will be the sole database, limiting advanced querying capabilities.
• The app must be optimized for Android devices first, with iOS support as a future consideration.

10. Glossary

• BMI: Body Mass Index, calculated as weight (kg) / height² (m²).
• SPO2: Peripheral capillary oxygen saturation, a measure of blood oxygen levels.
• SQLite: A lightweight, serverless database engine.
• PDF: Portable Document Format, used for generating reports.
• Backup/Restore: The process of saving and retrieving database data.

This document provides a comprehensive roadmap for the development of the shiny-employee app. Let me know if any adjustments are needed, Renish!