https://github.com/abdul-rafay19/aumc_guidevr_sdd
A complete Software Design Document (SDD) for AUMC GuideVR — detailing system architecture, design models, and process flows. Crafted as part of the Software Design & Architecture course using OOD & Agile-Scrum.
https://github.com/abdul-rafay19/aumc_guidevr_sdd
aumc aumc-guidevr sdd software-design-and-architecture software-design-documentation uml-diagram uml-diagrams virtual-reality vr
Last synced: 4 months ago
JSON representation
A complete Software Design Document (SDD) for AUMC GuideVR — detailing system architecture, design models, and process flows. Crafted as part of the Software Design & Architecture course using OOD & Agile-Scrum.
- Host: GitHub
- URL: https://github.com/abdul-rafay19/aumc_guidevr_sdd
- Owner: abdul-rafay19
- Created: 2025-06-30T07:51:29.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-06-30T18:50:16.000Z (11 months ago)
- Last Synced: 2025-07-31T00:45:10.628Z (10 months ago)
- Topics: aumc, aumc-guidevr, sdd, software-design-and-architecture, software-design-documentation, uml-diagram, uml-diagrams, virtual-reality, vr
- Homepage:
- Size: 1.18 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🎓 AUMC GuideVR – Software Design Document (SDD)
> A visionary VR-based campus navigation system
> 📘 Designed as part of **Software Design & Architecture** course
> 🧑💻 By Abdul Rafay & Abdul Rehman
> 🧭 Supervised by Hafiz Muhammad Anas Ali
> 🏫 Air University, Multan Campus – BSSE (2023–2027)
---
## 📌 About the Project
**AUMC GuideVR** is a virtual reality-based navigation solution designed for **Air University Multan Campus (AUMC)**.
This repository presents the **Software Design Document (SDD)**, crafted as a real-world design simulation under our **Software Design & Architecture** course.
Rather than coding first, we focused on *how* the system should be built — architecturally, structurally, and methodologically.
---
## 🔍 What’s Inside the SDD?
### 📐 Architecture
- Three-Tier Architecture (Presentation, Logic, Data)
- Modular, Scalable, Maintainable Design
- Web-based VR with A-Frame, WebXR, and Three.js
### 🧠 Design Methodologies
- **Object-Oriented Design (OOD)** for reusability & modularity
- **Agile with Scrum** for flexibility and iterative development
- Detailed comparison with Waterfall, V-Model, Spiral & RAD
### 🧩 Core Modules
| Module | Description |
|---------------------|---------------------------------------------------------------|
| VR Navigator | Indoor/outdoor VR movement & path rendering |
| Search & Explore | Smart POI lookup & search suggestions |
| Bookmark Manager | Save & revisit favorite campus spots |
| 360° Viewer | Immersive scene views for specific locations |
| Drone View | Bird’s-eye navigation for outdoor mapping |
| Data API Connector | Manages backend communication (Node.js, Express) |
---
## 🧬 UML Diagrams & Design Models
The SDD includes a rich set of UML diagrams and system design visuals:
- ✅ **Use Case Diagrams**
- ✅ **Class Diagrams**
- ✅ **Sequence Diagrams**
- ✅ **Swim Lane Diagrams**
- ✅ **Activity Flows for Core Features**:
- Indoor Navigation
- Outdoor Search
- Bookmark Location
- View/Manage Saved Spots
---
## 🔧 Tools & Tech (For Future Implementation)
| Purpose | Technologies |
|---------------------|--------------|
| Frontend VR | A-Frame, WebXR, Three.js, HTML/CSS/JS |
| Backend Logic | Node.js, Express |
| Database Layer | MongoDB / Firebase |
| Design & Modeling | UML, Lucidchart, Draw.io |
> 📌 Note: This repository only covers the **design**, not the implementation.
---
## 🌟 Why This Document Matters
> “Good code can’t fix bad architecture — but great design can prevent disaster.”
This Software Design Document lays the foundation for a real, scalable, and immersive VR system. It simulates a true industry-level design process — preparing us to think beyond code and see the bigger picture of software systems.
---
## 🤝 Acknowledgments
- 🙏 Special thanks to our instructor **Hafiz Muhammad Anas Ali** for the mentorship and critical design feedback.
- 💡 Inspired by challenges faced by students and visitors navigating unfamiliar campus grounds.
---
## 👥 Contributors
| Name | Role | Email |
|-----------------|-----------------------------|------------------------------|
| Abdul Rafay | Lead Designer & Documentation | 233679@students.au.edu.pk |
| Abdul Rehman | Co-Designer & Model Developer | 233711@students.au.edu.pk |
---