Merge branch 'main' into 137-reflection-doc

docs/Design/SoftArchitecture/MG.tex

@@ -9,6 +9,8 @@
 \usepackage{graphicx}
 \usepackage{float}
 \usepackage{hyperref}
+\usepackage{ulem}
+\newcommand{\rt}[1]{\textcolor{red}{#1}}
 \hypersetup{
     colorlinks,
     citecolor=blue,
@@ -50,6 +52,7 @@ \section{Revision History}
 Jan 13, 2024 & 1.0 & Initial Draft\\
 Jan 14 2024 & 1.1 & Revisit after MIS module decomposition\\
 Jan 17 2024 & 1.2 & Add abbreviations section\\
+Mar 27 2024 & 1.3 & Rev1\\
 \bottomrule
 \end{tabularx}
 
@@ -115,15 +118,30 @@ \section{Introduction}
 \subsection{Overview}
 This Module Guide Document serves as a design blueprint for MotionMingle - a WebRTC-based video conferencing application designed to enrich the experience of Tai Chi instruction. It presents a modular perspective of the project, guiding the development team in creating a platform that emphasizes real-time interaction, minimal hardware requirements, and ease of use.
 
-The document aligns with standards outlined in various project documents, including the SRS, HA, VnVPlan, SystDes, and MIS. \\
+\sout{The document aligns with standards outlined in various project documents, including the SRS, HA, VnVPlan, SystDes, and MIS.} 
 
-SRS - /docs/SRS/SRS.pdf \\
+\sout{SRS - /docs/SRS/SRS.pdf}
 
-HA - /docs/HazardAnalysis/HazardAnalysis.pdf \\
+\sout{HA - /docs/HazardAnalysis/HazardAnalysis.pdf}
 
-VnVPlan - /docs/VnVPlan/VnVPlan.pdf \\ 
+\sout{VnVPlan - /docs/VnVPlan/VnVPlan.pdf}
+
+\sout{MIS - /docs/Design/SoftDetailedDes/MIS.pdf}
+
+\rt{Relevant documentation include:}
+\begin{description}
+\item[\href{https://github.com/InfiniView-AI/MotionMingle/blob/main/docs/SRS/SRS.pdf}{\rt{SRS}}]
+ \rt{The SRS document is a related document as most of the requirements specified
+  in this document come from the SRS document.}
+\item[\href{https://github.com/InfiniView-AI/MotionMingle/blob/main/docs/HazardAnalysis/HazardAnalysis.pdf}{\rt{Hazard Analysis}}]
+  \rt{The Hazard Analysis document is a related document as some of the requirements
+  come from the Hazard Analysis document.}
+\item[\href{https://github.com/InfiniView-AI/MotionMingle/blob/main/docs/VnVPlan/VnVPlan.pdf}{\rt{VnVPlan}}]
+  \rt{The VnVPlan is essential as it outlines the approach for ensuring that the modules meet their specified requirements and work as intended.}
+\item[\href{https://github.com/InfiniView-AI/MotionMingle/blob/main/docs/Design/SoftDetailedDes/MIS.pdf}{\rt{Module Interface Specification}}]
+  \rt{The Module Interface Specification is pivotal for detailing the interactions between various system components, ensuring compatibility and defining the communication protocols necessary for module integration.}
+\end{description}
 
-MIS - /docs/Design/SoftDetailedDes/MIS.pdf \\
 
 \subsection{Purpose}
 The aim of this Module Guide Document is to detail the architecture of modules, based on selected design principles and patterns, to clarify the project’s functionalities and the specific roles of each module.
@@ -149,8 +167,10 @@ \subsection{Anticipated Changes} \label{SecAchange}
 adopted here is called design for change.
 
 \begin{description}
-\item[\refstepcounter{acnum} \actheacnum :] Video stream sharing by practitioners might be allowed for better user communications.
-\item[\refstepcounter{acnum} \actheacnum :] Audio stream sharing by practitioners might be allowed for better user communications.
+\item[\refstepcounter{acnum} \actheacnum :] \sout{Video stream sharing by practitioners might be allowed for better user communications.}\\
+\rt{The application shall enable the streaming of video content from any practitioners, ensuring clear visual communication for instructional purposes.}
+\item[\refstepcounter{acnum} \actheacnum :] \sout{Audio stream sharing by practitioners might be allowed for better user communications.}\\
+\rt{The application shall support audio streaming capabilities for practitioners to facilitate auditory communication.}
 \item[\refstepcounter{acnum} \actheacnum :] The number of annotation types available for users to choose from might change as discovered through the development process.
 
 \item[\refstepcounter{acnum} \actheacnum :] The initial release of the application has a limited load capacity, which will need to be expanded as the application's popularity grows to accommodate a growing number of users.
@@ -192,13 +212,15 @@ \subsection{Unlikely Changes} \label{SecUchange}
 
 \item[\refstepcounter{ucnum} \uctheucnum:] The fundamental feature of adding annotations to the video stream is not expected to change.
 
-\item[\refstepcounter{ucnum} \uctheucnum:] The application's design, ensuring compliance with relevant laws, is foreseen to remain unaltered.
+\item[\refstepcounter{ucnum} \uctheucnum:] \sout{The application's design, ensuring compliance with relevant laws, is foreseen to remain unaltered.}\\
+    \rt{The application’s design will include a strategy for regular legal reviews and updates, ensuring ongoing compliance with relevant laws. This shall enable the application to adapt to and incorporate changes in legal requirements as they arise.}
 
-\item[\refstepcounter{ucnum} \uctheucnum:] The client for this project is not expected to change, as it is designed as a student capstone project with limited market potential.
+\item[\refstepcounter{ucnum} \uctheucnum:] \sout{The client for this project is not expected to change, as it is designed as a student capstone project with limited market potential.}\\
+    \rt{The application shall be developed with a flexible architecture to accommodate potential future shifts in the client's requirements or market needs, ensuring the product remains viable and adaptable for broader deployment beyond the scope of the initial capstone project.}
 
 \item[\refstepcounter{ucnum} \uctheucnum:] The stakeholder for this project is unlikely to change, as it is a student capstone project adhering to specific course guidelines.
 
-\item[\refstepcounter{ucnum} \uctheucnum:] The project's schedule and budget constraints are anticipated to stay fixed, in line with the requirements of the student capstone course.
+\item[\refstepcounter{ucnum} \sout{\uctheucnum:}] \sout{The project's schedule and budget constraints are anticipated to stay fixed, in line with the requirements of the student capstone course.}
 \end{description}
 
 \section{Module Hierarchy} \label{SecMH}
@@ -583,10 +605,10 @@ \section{Use Hierarchy Between Modules} \label{SecUse}
     \label{FigUH}
     \end{figure}
 
-\section{Timeine}
+\section{\rt{Timeline}}
 
 \begin{itemize}
-  \item \textbf{Week 1 - 2:}
+  \item \textbf{Week 1 - 2:} \rt{Dec 1 - Dec 14, 2023}
   \begin{itemize}
       \item M2: User Authentication Module
       \begin{itemize}
@@ -599,7 +621,7 @@ \section{Timeine}
           \item Define interfaces for other modules (Kehao)
       \end{itemize}
   \end{itemize}
-  \item \textbf{Week 3 - 4:}
+  \item \textbf{Week 3 - 4:} \rt{Dec 15 - Dec 30, 2023}
   \begin{itemize}
       \item M13: SFU Server Module
       \begin{itemize}
@@ -612,15 +634,15 @@ \section{Timeine}
           \item Implementation (Kehao, Qianlin)
       \end{itemize}
   \end{itemize}
-  \item \textbf{Week 5:}
+  \item \textbf{Week 5:} \rt{Jan 1 - Jan 7, 2024}
   \begin{itemize}
       \item M10: Video Transform Module
       \begin{itemize}
           \item Research on video transformation techniques (Qianlin, Xunzhou, Anhao)
           \item Initial implementation (Qianlin, Xunzhou, Anhao)
       \end{itemize}
   \end{itemize}
-  \item \textbf{Week 6 - 7:}
+  \item \textbf{Week 6 - 7:} \rt{Jan 8 - Jan 21, 2024}
   \begin{itemize}
       \item M3: Instructor View Module
       \begin{itemize}
@@ -633,7 +655,7 @@ \section{Timeine}
           \item Backend integration (Qianlin, Xunzhou, Anhao)
       \end{itemize}
   \end{itemize}
-  \item \textbf{Week 8 - 9:}
+  \item \textbf{Week 8 - 9:} \rt{Jan 24 - Feb 7, 2024}
   \begin{itemize}
       \item M7: RTC Control Module
       \begin{itemize}
@@ -646,7 +668,7 @@ \section{Timeine}
           \item Integration with Video Transform Module (Xunzhou, Anhao)
       \end{itemize}
   \end{itemize}
-  \item \textbf{Week 10 - 11:}
+  \item \textbf{Week 10 - 11:} \rt{Feb 14 - Feb 28, 2024}
   \begin{itemize}
       \item M11: Human Pose Estimation Annotation Module
       \begin{itemize}
@@ -659,7 +681,7 @@ \section{Timeine}
           \item Integration with Human Pose Estimation (Qianlin, Xunzhou)
       \end{itemize}
   \end{itemize}
-  \item \textbf{Week 12 - 13:}
+  \item \textbf{Week 12 - 13:} \rt{Mar 1 - Mar 15, 2024}
   \begin{itemize}
       \item M5: Annotation Configuration Module
       \begin{itemize}