aindreas/fyp
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[report]: Add Help page

Browse Source
This commit is contained in:
Aindréas Ó hAodha
2025-04-03 03:41:38 +01:00
parent e31bcae676
commit 5ae4cb0646
3 changed files with 12 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
report/images/helppage.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 186 KiB

BIN
report/report.pdf
View File

Binary file not shown.

13
report/report.tex
View File

@ -754,12 +754,14 @@ The frontend design is built following the Single-Page-Application (SPA)\superci
Since there is just one initial page load, the content is dynamically updated via the DOM using JavaScript rather than by requesting new pages from the server; Since there is just one initial page load, the content is dynamically updated via the DOM using JavaScript rather than by requesting new pages from the server;
navigation between pseudo-pages is managed entirely using client-side routing for a smoother \& faster user experience since no full-page reloads are necessary. navigation between pseudo-pages is managed entirely using client-side routing for a smoother \& faster user experience since no full-page reloads are necessary.
\\\\ \\\\
The web application is split into two ``pages'': The web application is split into three ``pages'':
\begin{itemize} \begin{itemize}
\item The home (or map) page, which is the main page that displays live location data \& service information to the user. \item The home (or map) page, which is the main page that displays live location data \& service information to the user.
This page is where the user will spend the majority of their time, and where the majority of the functionality is delivered. This page is where the user will spend the majority of their time, and where the majority of the functionality is delivered.
\item The statistics page, which is used to deliver statistical insights about the data to the user. \item The statistics page, which is used to deliver statistical insights about the data to the user.
This page is for providing deeper insights into the stored data on a collective basis, rather than on a per-service basis. This page is for providing deeper insights into the stored data on a collective basis, rather than on a per-service basis.
\item The help page, which gives some basic usage information on how to complete basic tasks within the application, in keeping with Nielsen's usability heuristic of ``Help and Documentation''\supercite{nielsenheuristics}.
\end{itemize} \end{itemize}
The web application follows the Container/Presentational Pattern\supercite{containerpresentational}, which enforces separation of concerns by separating the presentational logic from the application logic. The web application follows the Container/Presentational Pattern\supercite{containerpresentational}, which enforces separation of concerns by separating the presentational logic from the application logic.
@ -1141,6 +1143,15 @@ Pie charts are somewhat controversial in the realm of data visualisation and are
when the data being illustrated is a part-to-whole representation, when there is no more than 5 categories in the pie chart, and when there are not small differences between the categories\supercite{atlassianpiechart, spotfirepie, inforirver}. when the data being illustrated is a part-to-whole representation, when there is no more than 5 categories in the pie chart, and when there are not small differences between the categories\supercite{atlassianpiechart, spotfirepie, inforirver}.
Since the data for this application fulfils these criteria, and because testing with bar charts resulted with more difficult to understand results (as part of the proportion), pie charts were deemed suitable for this purpose. Since the data for this application fulfils these criteria, and because testing with bar charts resulted with more difficult to understand results (as part of the proportion), pie charts were deemed suitable for this purpose.
\section{Help Page}
\begin{figure}[H]
\centering
\includegraphics[width=\textwidth]{./images/helppage.png}
\caption{Screenshot of the help page}
\end{figure}
The help page is a very simple web page that just contains questions and answers on how to perform basic tasks, such as favouriting an item or viewing real-time Luas information.
\chapter{Evaluation} \chapter{Evaluation}
\section{Objectives Fulfilled} \section{Objectives Fulfilled}
\section{Heuristic Evaluation: Nielsen's 10} \section{Heuristic Evaluation: Nielsen's 10}