NOTE: This is an imaginary project and is not in any way an official document
This document is a Software Design Document (SDD) for the Oil Declaration System, produced by Royal Jordanian Airlines (RJ). It outlines the design, requirements, and architecture of a web application aimed at streamlining the declaration process for non-flammable oil carried by travelers.
This document is a Software Design Document (SDD) produced by Royal Jordanian Airlines (RJ), the national airline of Jordan. The SDD covers the problem statement, proposed solution, risk areas, and product overview, including functional and nonfunctional requirements. It also discusses the overall design, including high-level and low-level design elements such as sitemaps, wireframes, ERD, and UML diagrams.
The purpose of this SDD is to provide a clear description of the design of a web application used by Royal Jordanian Airlines (RJ) for declaring non-flammable oil. It includes details on database design, architecture, and user interface.
Objective: To streamline the declaration process for non-flammable oil, making it quick and hassle-free for travelers.
In-Scope:
- User authentication.
- Validation of oil bottle compliance with rules and regulations.
- Allow users to edit their declarations.
Out-Scope:
- Integration with external travel booking systems.
- Language translation.
- Physical storage and handling of oil bottles.
- Project Management Department: Responsible for managing and funding the project.
- Marketing Department: Responsible for marketing the application.
- Developers: Responsible for executing and producing the project.
- Designers: Responsible for designing the user interface and user experience.
- Customers: The main users of the application.
| Abbreviation | Full Form |
|---|---|
| RJ | Royal Jordanian Airlines |
| HTU | AI-Hussein Technical University |
| SDD | Software Design Document |
| Non-Flammable Oils | Standard motor oils and food oils such as olive oil and corn oil. |
The current process of declaring non-flammable oil for transportation in checked bags is cumbersome and prone to errors. Travelers face challenges in efficiently providing the necessary information, leading to potential complications during airport security checks. The goal is to reduce the hassle for RJ travelers by streamlining the declaration process.
The project is a web application that allows travelers to declare non-flammable oil in their checked bags. Travelers can input their personal and flight information, along with details about the oil bottle, to ensure compliance with airline regulations.
Benefits:
- Ensures compliance with airline regulations.
- Reduces the likelihood of complications during airport security checks.
- Minimizes errors in submitted information.
- Travelers: Users of the web application.
- Administrators: Manage and oversee the system.
- Regulatory Authorities: Set and enforce regulations.
- Airline Representatives: Ensure compliance with airline policies.
- Developers: Design, develop, and maintain the application.
- IT Security Experts: Ensure the security of user data.
- Executive Leadership: Align the project with organizational goals.
- Travelers: Users of the web application.
- Administrators: Manage and oversee the system.
- Database: Stores and retrieves data.
- Server: Manages user requests and loads the application.
| Phase | Risk | Priority |
|---|---|---|
| Design | Changes in regulatory requirements may impact design decisions. | Medium |
| Development | Data breaches could compromise user data and RJ's integrity. | High |
| Testing | Insufficient test coverage may lead to undetected bugs. | Medium |
| Functional Requirement | Priority |
|---|---|
| User Registration and Authentication | High |
| Mobile Responsiveness | High |
| Rules and Regulations Page | Medium |
| Declaration of Oil in Travelers' Luggage | High |
Use case diagrams predict user interactions with the application. They show how users will interact with the system and its functionalities.
- Scalability: The system should be able to handle additional items in the future.
- Availability: Minimal downtime is crucial as flights operate 24/7.
- Security: Sensitive user data must be protected.
- Portability: The website should be accessible on mobile devices.
- Compliance: The system must comply with international oil carriage guidelines.
Class diagrams document the software architecture, showing objects in the system and their relationships.
The sitemap shows the hierarchy and number of pages in the application.
- Home: Landing page with login, registration, and a welcome message.
- User Dashboard: User-specific dashboard for managing profiles and declarations.
- Declaration Form: Page for inputting personal information, flight details, and oil bottle information.
- Admin Dashboard: Admin-specific dashboard for managing declarations and users.
- Contact Us: Page with contact information for user support.
Wireframes are provided in the PDF version of this document.
Mockups are provided in the PDF version of this document.
The Entity Relationship Diagram (ERD) is provided in the PDF version of this document.