mirror of
				https://github.com/smyalygames/checklist-tester.git
				synced 2025-11-04 04:59:48 +01:00 
			
		
		
		
	feat(dissertation): add explanation about desigining in 3.3
This commit is contained in:
		
							parent
							
								
									2880c99007
								
							
						
					
					
						commit
						680a3b9c25
					
				@ -1,6 +1,7 @@
 | 
				
			|||||||
\documentclass[../dissertation.tex]{subfiles}
 | 
					\documentclass[../dissertation.tex]{subfiles}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
\begin{document}
 | 
					\begin{document}
 | 
				
			||||||
 | 
					%%%%% COMPONENTS %%%%%
 | 
				
			||||||
\section{Components}
 | 
					\section{Components}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Splitting up the project into multiple components has been useful for
 | 
					Splitting up the project into multiple components has been useful for
 | 
				
			||||||
@ -30,7 +31,9 @@ Splitting up the project into multiple components has been useful for
 | 
				
			|||||||
Each of the components in Figure~\ref{fig:abstract} will be covered in detail in this
 | 
					Each of the components in Figure~\ref{fig:abstract} will be covered in detail in this
 | 
				
			||||||
chapter.
 | 
					chapter.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
\section{Model}
 | 
					
 | 
				
			||||||
 | 
					%%%%% FORMAL METHOD %%%%%
 | 
				
			||||||
 | 
					\section{Formal Method}
 | 
				
			||||||
\begin{itemize}
 | 
					\begin{itemize}
 | 
				
			||||||
  \item Formal modelling is the heart of the logic for testing checklists
 | 
					  \item Formal modelling is the heart of the logic for testing checklists
 | 
				
			||||||
  \item Formal model created using VDM-SL
 | 
					  \item Formal model created using VDM-SL
 | 
				
			||||||
@ -50,6 +53,49 @@ chapter.
 | 
				
			|||||||
    \end{itemize}
 | 
					    \end{itemize}
 | 
				
			||||||
\end{itemize}
 | 
					\end{itemize}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					%%%%% CHECKLIST TESTER %%%%%
 | 
				
			||||||
 | 
					\section{Checklist Tester}
 | 
				
			||||||
 | 
					Brief overview of what it is supposed to do... % TODO
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					\subsection{Designing}
 | 
				
			||||||
 | 
					\begin{itemize}
 | 
				
			||||||
 | 
					  \item Used Figma to create a design for the application
 | 
				
			||||||
 | 
					  \item Allows for implementing the front end to be faster because:
 | 
				
			||||||
 | 
					    \begin{itemize}
 | 
				
			||||||
 | 
					      \item They act as a requirement for code
 | 
				
			||||||
 | 
					      \item You do not forget what needs to be implemented
 | 
				
			||||||
 | 
					      \item Keeps everything consistent
 | 
				
			||||||
 | 
					      \item Allows to think about making parts of the GUI modular and what components can be reused
 | 
				
			||||||
 | 
					    \end{itemize}
 | 
				
			||||||
 | 
					  \item Figma allows for plugins such as Material 3 colours and Material 3 components
 | 
				
			||||||
 | 
					  \item Figure~\ref{fig:figma-gui} is the final design that will be used for the
 | 
				
			||||||
 | 
					    program
 | 
				
			||||||
 | 
					\end{itemize}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					\begin{figure}
 | 
				
			||||||
 | 
					  \centering
 | 
				
			||||||
 | 
					  \includegraphics[width=\columnwidth]{images/figma-gui.pdf}
 | 
				
			||||||
 | 
					  \caption[GUI in Figma]{Design for the Checklist Connector GUI in Figma}
 | 
				
			||||||
 | 
					  \label{fig:figma-gui}
 | 
				
			||||||
 | 
					\end{figure}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					\subsubsection{Limitations of Figma}
 | 
				
			||||||
 | 
					\begin{itemize}
 | 
				
			||||||
 | 
					  \item The Material 3 Components in Figma do not include features that are available in
 | 
				
			||||||
 | 
					    Jetpack Compose
 | 
				
			||||||
 | 
					  \item In this project, the \enquote{Simulator Test} at the bottom of Figure~\ref{fig:figma-gui}
 | 
				
			||||||
 | 
					    does not include a leading icon~\cite{material:lists}, and therefore had to be a trailing
 | 
				
			||||||
 | 
					    checkbox
 | 
				
			||||||
 | 
					  \item This was overcome by adding comments in Figma as a reminder of how the actual implementation
 | 
				
			||||||
 | 
					    should be like
 | 
				
			||||||
 | 
					  \item Another limitation is that in Figure~\ref{fig:figma-gui}, the title of the screen in the
 | 
				
			||||||
 | 
					    top app bar~\cite{material:top-app-bar} is not centered, and that is because the auto layout
 | 
				
			||||||
 | 
					    feature in Figma allows for equal spacing, rather than having each in a set position
 | 
				
			||||||
 | 
					\end{itemize}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					%%%%% SCENARIOS %%%%%
 | 
				
			||||||
\section{Scenarios}
 | 
					\section{Scenarios}
 | 
				
			||||||
\begin{itemize}
 | 
					\begin{itemize}
 | 
				
			||||||
  \item Use a Quick Reference Handbook (QRH) to find potential list of checklists to test
 | 
					  \item Use a Quick Reference Handbook (QRH) to find potential list of checklists to test
 | 
				
			||||||
@ -60,5 +106,7 @@ chapter.
 | 
				
			|||||||
    look out for
 | 
					    look out for
 | 
				
			||||||
\end{itemize}
 | 
					\end{itemize}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					%%%%% DECISIONS %%%%%
 | 
				
			||||||
\section{Decisions}
 | 
					\section{Decisions}
 | 
				
			||||||
\end{document}
 | 
					\end{document}
 | 
				
			||||||
 | 
				
			|||||||
										
											Binary file not shown.
										
									
								
							@ -49,6 +49,8 @@
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
\usepackage{pgf-pie}
 | 
					\usepackage{pgf-pie}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					\usepackage{graphicx}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
% For referencing
 | 
					% For referencing
 | 
				
			||||||
\usepackage[citestyle=ieee]{biblatex}
 | 
					\usepackage[citestyle=ieee]{biblatex}
 | 
				
			||||||
\addbibresource{references.bib}
 | 
					\addbibresource{references.bib}
 | 
				
			||||||
 | 
				
			|||||||
							
								
								
									
										
											BIN
										
									
								
								pub/dissertation/images/figma-gui.pdf
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								pub/dissertation/images/figma-gui.pdf
									
									
									
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							@ -209,3 +209,17 @@
 | 
				
			|||||||
  urldate = {2024-04-21},
 | 
					  urldate = {2024-04-21},
 | 
				
			||||||
}
 | 
					}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					@online{material:lists,
 | 
				
			||||||
 | 
					  author = {Google LLC},
 | 
				
			||||||
 | 
					  title = {Lists – Material Design 3},
 | 
				
			||||||
 | 
					  url = {https://m3.material.io/components/lists/guidelines},
 | 
				
			||||||
 | 
					  urldate = {2024-05-13},
 | 
				
			||||||
 | 
					}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					@online{material:top-app-bar,
 | 
				
			||||||
 | 
					  author = {Google LLC},
 | 
				
			||||||
 | 
					  title = {Top app bar – Material Design 3},
 | 
				
			||||||
 | 
					  url = {https://m3.material.io/components/top-app-bar/guidelines},
 | 
				
			||||||
 | 
					  urldate = {2024-05-13},
 | 
				
			||||||
 | 
					}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user