Skip to content
Snippets Groups Projects
Commit 283818ae authored by Riley Mcgee's avatar Riley Mcgee
Browse files

Document read over and corrections

parent 9ef443c2
No related branches found
No related tags found
No related merge requests found
No preview for this file type
......@@ -29,12 +29,12 @@
\newcommand{\mthemnum}{M\themnum}
\newcommand{\mref}[1]{M\ref{#1}}
\title{SE 3XA3: Software Requirements Specification\\Title of Project}
\title{SE 3XA3: Module Guide\\Gifitti}
\author{Team \#, Team Name
\author{Team \#2, Gifitti
\\ Riley McGee, mcgeer
\\ Pavle Arezina, arezinp
\\ Student 3 name and macid
\\ Nicolai Kozel, kozeln
}
\date{\today}
......@@ -58,6 +58,7 @@
November 9th 2016 & 1.0 & Added Module Hierarchy\\
November 9th 2016 & 1.1 & Added Module Decomposition\\
November 11th 2016& 1.2& Added Section 2 and 6\\
November 13th 2016& 2.0& Spelling and grammatical issues addressed\\
... & ... & ... \\
\bottomrule
\end{tabularx}
......@@ -78,7 +79,7 @@ hides represent likely future changes. Design for change is valuable in SC,
where modifications are frequent, especially during initial development as the
solution space is explored.
Our design follows the rules layed out by \citet{ParnasEtAl1984}, as follows:
Our design follows the rules laid out by \citet{ParnasEtAl1984}, as follows:
\begin{itemize}
\item System details that are likely to change independently should be the
secrets of separate modules.
......@@ -221,19 +222,19 @@ description of the design decisions and how they impact the major functional
and non functional requirements.
\begin{enumerate}
\item User can provide input and get ouput from the system (i.e open and save a GIF). \\\\ This requirement is satisfied through the use
\item User can provide input and get output from the system (i.e open and save a GIF). \\\\ This requirement is satisfied through the use
of buttons/file dialogs and is handled primary through C\#'s built in libraries as well as the Image Loading Module and Image Conversion Module.
\item Once a GIF is loaded by the user, it must playback in the window and playback must be able to be stopped and started by the user. \\\\
This requirement is primarily handled by the GIF Model Module. To ensure this requirement is met, the design is being implemented so that the GIF Model
will handle the frames and functions of playing back the GIF.
\item The user must be able to modify the GIF including clipping, frame injection, and possibly add text or other make modifications. \\\\
This requirement is met through the GIF Transformation Module. This module contains all the possibilities of modifications that can be applied to the GIF.
These functions are seperated from the GIF Model Module to provide us with the ability to make changes to the model without affecting the behavior
These functions are separated from the GIF Model Module to provide us with the ability to make changes to the model without affecting the behavior
of the system and having to modify all of the transformation functions. These functions will also be implemented through the use of buttons and click gestures.
\item In general, the system must operate at a high performance rate. This includes a high frame rate during playback and fast/responsive UI elements and load times. \\\\ Some design decisons that were made to ensure this were how the modules were decomoposed and the choice of image framework to work with.
\item In general, the system must operate at a high performance rate. This includes a high frame rate during playback and fast/responsive UI elements and load times. \\\\ Some design decisions that were made to ensure this were how the modules were decomposed and the choice of image framework to work with.
The system is decomposed in such a way to ensure the code is efficient and any algorithms used operate at an optimal rate. The UI elements and file manipulation methods were specifically chosen to be the fastest possible to ensure a positive experience for the user.
\item The program should have a clean UI design and easily usable by people older than 10 years old. \\\\ Design decisions were made during the implementation of the system to ensure this requirement. These included the size of the buttons, the font size/colors, and the general layout. The original application (GIF Viewer)
had a fairly usable interface already, so we simply expanded off of this but attempted to make it even simpler and cleaner by eliminating unneccesary and confusing submenus. Instead, every button serves a single purpose.
had a fairly usable interface already, so we simply expanded off of this but attempted to make it even simpler and cleaner by eliminating unnecessary and confusing submenus. Instead, every button serves a single purpose.
\end{enumerate}
......@@ -298,14 +299,14 @@ selected.
\subsubsection{GIF Model Module (\mref{mGM})}
\begin{description}
\item[Secrets:] GIF images are represented in a Frame-By-Frame manner to establish easy handling of GIFS. the Images themselves are not strictly of the GIF format they are used to model the GIF image.
\item[Secrets:] GIF images are represented in a Frame-By-Frame manner to establish easy handling of GIFs. the Images themselves are not strictly of the GIF format they are used to model the GIF image.
\item[Services:]
\begin{itemize}
%Brute Force Formatting Leave here
\end{itemize}
\begin{itemize}
\item Hold initial GIF image for data security.
\item Make GIF MetaData availiable and editable.
\item Make GIF meta data available and editable.
\item Represent how the user will view the GIF in the system.
\end{itemize}
\item[Implemented By:] Gifitti
......@@ -343,8 +344,8 @@ selected.
\subsubsection{GIF Transformation Module (\mref{mGT})}
\begin{description}
\item[Secrets:] Frame-By-Frame Manipulation of Gif Modelsto obtain desired results.
\item[Services:] Converts GIF's into a new GIF based on desired transformations.
\item[Secrets:] Frame-By-Frame Manipulation of GIF Models to obtain desired results.
\item[Services:] Converts GIFs into a new GIF based on desired transformations.
Transformations include: Reset, Resize, Add Frame(s), Remove Frame(s), Rotate, Modify Speed ...
\item[Implemented By:] Gifitti
\end{description}
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment