diff --git a/BlankProjectTemplate/Doc_Revision1/SRS/SRS.pdf b/BlankProjectTemplate/Doc_Revision1/SRS/SRS.pdf index ad7e7e58e7d553aa98130819231c4f25dbcb8d21..c9144aff43478254557daefd7bf491acf7885064 100644 Binary files a/BlankProjectTemplate/Doc_Revision1/SRS/SRS.pdf and b/BlankProjectTemplate/Doc_Revision1/SRS/SRS.pdf differ diff --git a/BlankProjectTemplate/Doc_Revision1/SRS/SRS.tex b/BlankProjectTemplate/Doc_Revision1/SRS/SRS.tex index 7237f99d7b307ff4829435d7510a87202e283473..2617cae072231141ae195fcdb3c2bdf2c650be2d 100644 --- a/BlankProjectTemplate/Doc_Revision1/SRS/SRS.tex +++ b/BlankProjectTemplate/Doc_Revision1/SRS/SRS.tex @@ -40,7 +40,7 @@ \midrule Oct 5, 2018 & 1.0 & Andy worked on Project Drivers and Project Issues. Usman worked on Functional requirements. Vaibhav worked on Non-Functional Requirements\\ \textcolor{red}{Dec 2, 2018} & 1.1 & Vaibhav is performing revision 1 in order to improve the quality of the document\\ -\textcolor{blue}{Dec 2, 2018} & 1.1 & Andy edited the formatting issues stated in feedback for Revision 1\\ +\textcolor{red}{Dec 2, 2018} & 1.1 & Andy edited the formatting issues stated in feedback for Revision 1 | Edited Health and Safety NF requirement\\ \textcolor{red}{Dec 2, 2018} & 1.1 & Usman is performing revision 1 in order to improve the quality of the document\\ \bottomrule \end{tabularx} @@ -79,7 +79,7 @@ The main users or customers are desktop gamers, older generation of game enthus \subsubsection{Other Stakeholders} -Aside from the clients and customers, other stakeholder include 3rd party Desktop game distribution stores and open source project banks which may make use of this project for development purposes: +Other stakeholders include 3rd party Desktop game distribution stores,\textcolor{red}{such as Google Play and the Apple store,} and open source project banks which may make use of this project for development purposes: \begin{itemize} \item 3rd party desktop game distribution stores. @@ -115,8 +115,11 @@ used as of now: \item OS: Operating System. \item Python: The programming language used for application development. \item Pygame: Computer graphics Python library. +\textcolor{red}{\item HTML: The standard markup language for creating Web pages. HTML stands for Hyper Text Markup Language. +\item CSS: Cascading style sheets (CSS) are used to format the layout of Web pages. +\item JS: Javascript is the programming language of HTML and the Web.} \item Snake 2.o: The desktop application being developed in Python. -\item The interface: The graphics developed using Pygame. +\item UI: The user interface graphics developed using Pygame. \item The source game: The open source original Python snake game being used for this project. \end{itemize} @@ -149,10 +152,8 @@ have a smooth user-interface. \section{Functional Requirements} \subsection{The Scope of the Work and the Product} -% Summarize Gantt Chart \subsubsection{The Context of the Work} -% The scope of the project is deliver a Product that has the requirement documentation, and a desktop application that can be installed on a user's system.\\ \\To achieve the goals of the Product, the following are decided to be the deadlines of the goal to be on the track:\\ $\bullet$ Development Plan \date{28/09/18}\\ @@ -174,19 +175,19 @@ The user can use the system-to-be (the desktop application) to entertain themsel $\bullet$ Requirement number: FR(Functional Requirement)1\\ -\textcolor{red}{When the user sees the interface, it can select the buttons on the screen by using the computer's mouse.}\\ +\textcolor{red}{When the user sees the interface, they can select the buttons on the screen by using the computer's mouse.}\\ $\bullet$ Requirement number: FR2\\ The user can press the UP key to move the snake's direction in the upwards direction.\\ $\bullet$ Requirement number: FR3\\ -The user can press the DOWN key to move the snake's direction in the downwards direction.\\ +The user can press the DOWN key to move the snake in the downwards direction.\\ $\bullet$ Requirement number: FR4\\ -The user can press the LEFT key to move the snake's direction in the left direction.\\ +The user can press the LEFT key to move the snake in the left direction.\\ $\bullet$ Requirement number: FR5\\ -The user can press the \textcolor{red}{RIGHT} key to move the snake's direction in the right direction.\\ +The user can press the \textcolor{red}{RIGHT} key to move the snake in the right direction.\\ $\bullet$ Requirement number: FR6\\ The game should display the user's highest score.\\ @@ -234,14 +235,15 @@ $\bullet$ Requirement number: FR18\\ \subsubsection{Appearance Requirements :\textcolor{red}{NFR1}} -The final product shall be a desktop application which will contain a playground with a snake in it. It shall have different theme options and buttons to \textcolor{red}{select different modes to play with. In addition, there should be a help page for a new player in order to get familiar with the commands to play this game}. Also, it shall show the highest score made on the specific device. + \textcolor{red}{In each UI component, such as the main screen, gameplay screen and exit screen, the color scheme shall be chosen using color theory to reveal a pleasant appearance. The scheme can differ between UI components but fonts should stay consistent throughout and only a few colors shall be used altogether. } + -\textcolor{red}{Fit Criterion: The game will be ran and checked if all the mentioned options pop up.} +\textcolor{red}{Fit Criterion: No more than 8 colors used in the UI and the color scheme of UI components. At most, 2 fonts will be used at all times across all UI components} \subsubsection{Style Requirements:\textcolor{red}{NFR2}} The product should be given a modern style by adding a nice background to it with a user-friendly interface. -\textcolor{red}{Fit Criterion: The game will be ran and beta testing will be performed to check this.} +\textcolor{red}{Fit Criterion: The background shall be composed of a solid color background or a background containing one object to give off a modern, simplistic look } \subsection{Usability and Humanity Requirements:\textcolor{red}{NFR3}} The application must be simple for a person aged 10 or above. It should be understandable by any person within the age group who is familiar to the technology. No feature should restrict the player to a non-knowledgeable outcome. @@ -423,11 +425,16 @@ Some rudimentary ideas for project modules and solutions have been mentioned dow \section{Appendix} -NA +\textcolor{red}{N/A} \subsection{Symbolic Parameters} -NA - +\textcolor{red}{ +\begin{itemize} +\item NFR - Nonfunctional requirement +\item FR - Functional requirement +\item *Any acronym used in the Naming Conventions and Terminology section (i.e. HTML, CSS , JS etc.) +\end{itemize} +} \end{document} \ No newline at end of file