diff options
| -rw-r--r-- | csci5801/a1.tex | 87 | ||||
| -rw-r--r-- | csci5801/img/diagram.png | bin | 0 -> 22787 bytes | |||
| -rw-r--r-- | csci5801/usecases.sty | 64 |
3 files changed, 136 insertions, 15 deletions
diff --git a/csci5801/a1.tex b/csci5801/a1.tex index 3f8704f..d1cb861 100644 --- a/csci5801/a1.tex +++ b/csci5801/a1.tex @@ -21,6 +21,8 @@ \usepackage[bookmarks=true]{hyperref} \usepackage[utf8]{inputenc} \usepackage[english]{babel} +\usepackage{graphicx} +\graphicspath{{./img/}} \def\myversion{1.0 } \date{} %\title{% @@ -53,31 +55,31 @@ \section{Purpose} -$<$Identify the product whose software requirements are specified in this -document, including the revision or release number. Describe the scope of the -product that is covered by this SRS, particularly if this SRS describes only -part of the system or a single subsystem.$>$ +The purpose is to provide a description for the Sports League Administration Manager (SLAM). It will explain the purposes, features, interfaces, and designed use cases for the system. This is intended for both the Minneapolis Parks and Recreation Board and the developers of the service. + +\section{Document Conventions} + +This Document made to comply with the IEEE Software Requirements Format. \section{Intended Audience and Reading Suggestions} -$<$Describe the different types of reader that the document is intended for, -such as developers, project managers, marketing staff, users, testers, and -documentation writers. Describe what the rest of this SRS contains and how it is -organized. Suggest a sequence for reading the document, beginning with the -overview sections and proceeding through the sections that are most pertinent to -each reader type.$>$ +This document is designed to be read by the developers creating and maintaining SLAM, the administrators at the Minneapolis Parks and Recreation Board, and the athletes, league administrators, coaches, and other interested parties. \section{Project Scope} -SLAM will be used by the Minneapolis Municipal Parks and Recreation to organize -$<$Provide a short description of the software being specified and its purpose, -including relevant benefits, objectives, and goals. Relate the software to -corporate goals or business strategies. If a separate vision and scope document -is available, refer to it rather than duplicating its contents here.$>$ +SLAM will be used by Minneapolis Municipal Parks and Recreation to organize sports leagues throughout the city. The system will provide methods for creating, managing, and administering sports leagues as well as assign officials. The system will also allow coaches to create teams and add players to teams. +\section{References} +\noindent +Sports League Administration Manager (SLAM) Software Requirements \\ +\noindent +Sports League Administration Manager (SLAM) Use Cases \chapter{Overall Description} \section{Product Perspective} +\includegraphics[width=\textwidth]{diagram} \\ + +The Sports League Administation Manager is developed to organize a $<$Describe the context and origin of the product being specified in this SRS. For example, state whether this product is a follow-on member of a product family, a replacement for certain existing systems, or a new, self-contained @@ -96,6 +98,25 @@ related requirements and how they relate, such as a top level data flow diagram or object class diagram, is often effective.$>$ \section{User Classes and Characteristics} +The system is divided into four users: administrators, officials, coaches, and the public. The roles are defined as follows: \\ +Adminisrators: +\begin{itemize} + \item Create and manage leagues + \item Create and manage league and tournament schedules + \item Generate user statistics on demand + \item Assign officials to leagues and games + \item Accept sponsorships +\end{itemize} +Officials: +\begin{itemize} + \item Submit their availability to official games + \item View the schedule of games they need to attend +\end{itemize} +Coaches: +\begin{itemize} + \item Create teams + \item +\end{itemize} $<$Identify the various user classes that you anticipate will use this product. User classes may be differentiated based on frequency of use, subset of product functions used, technical expertise, security or privilege levels, educational @@ -200,7 +221,43 @@ Include how the product should respond to anticipated error conditions or invalid inputs. Requirements should be concise, complete, unambiguous, verifiable, and necessary. Use “TBD” as a placeholder to indicate when necessary information is not yet available.$>$ +$<$This template illustrates organizing the functional requirements for the +product by system features, the major services provided by the product. You may +prefer to organize this section by use case, mode of operation, user class, +object class, functional hierarchy, or combinations of these, whatever makes the +most logical sense for your product.$>$ + +\section{League Creation} +\subsection{Description and Priority} + + +\subsection{Stimulus/Response Sequences} +$<$List the sequences of user actions and system responses that stimulate the +behavior defined for this feature. These will correspond to the dialog elements +associated with use cases.$>$ + +\subsection{Functional Requirements} +$<$Itemize the detailed functional requirements associated with this feature. +These are the software capabilities that must be present in order for the user +to carry out the services provided by the feature, or to execute the use case. +Include how the product should respond to anticipated error conditions or +invalid inputs. Requirements should be concise, complete, unambiguous, +verifiable, and necessary. Use “TBD” as a placeholder to indicate when necessary +information is not yet available.$>$ + +$<$Each requirement should be uniquely identified with a sequence number or a +meaningful tag of some kind.$>$ + +REQ-1: REQ-2: + +\section{Team Creation} + + \subsection{Description and Priority} + + \subsection{Stimulus/Response Sequences} + + \subsection{Functional Requirements} $<$Each requirement should be uniquely identified with a sequence number or a meaningful tag of some kind.$>$ diff --git a/csci5801/img/diagram.png b/csci5801/img/diagram.png Binary files differnew file mode 100644 index 0000000..6166f77 --- /dev/null +++ b/csci5801/img/diagram.png diff --git a/csci5801/usecases.sty b/csci5801/usecases.sty new file mode 100644 index 0000000..c31fd51 --- /dev/null +++ b/csci5801/usecases.sty @@ -0,0 +1,64 @@ +%% Use Cases Style File +%% Created by Tom Desair (http://www.tomdesair.com) +%% Downloadable at: http://www.tomdesair.com/downloads/use-case-latex-template.zip +%% Date Modified: 03/04/2012 +% +% This work may be distributed and/or modified under the +% conditions of the LaTeX Project Public License, either version 1.3 +% of this license or (at your option) any later version. +% The latest version of this license is in +% http://www.latex-project.org/lppl.txt +% and version 1.3 or later is part of all distributions of LaTeX +% version 2005/12/01 or later. + +%------------------------------------------------------------------------------- +% Required Packages +%------------------------------------------------------------------------------- +\usepackage{booktabs} +\usepackage{multirow} +\usepackage{longtable} + +%------------------------------------------------------------------------------- +% \addtitle command: add the title of the use case +%------------------------------------------------------------------------------- +\newcommand\addtitle[2]{\hline \\ [-1.5ex] \textbf{#1} &\textbf{#2}\\ [1ex] \hline \\ [-1.5ex]} +\newcommand\tabularhead{\begin{longtable}{lp{8.9cm}} +} + +%------------------------------------------------------------------------------- +% \addfield command: add a property of the use case +%------------------------------------------------------------------------------- +\newcommand\addfield[2]{\textit{#1} \\ [1ex] \hline \\ [-1.3ex] } + +%------------------------------------------------------------------------------- +% \addscenario command: add the main (or alternative) scenario +% of the use case +%------------------------------------------------------------------------------- +\newcommand\addscenario[2]{ +\multicolumn{2}{l}{\textit{#1}} \\ +\multicolumn{2}{l}{ +\begin{minipage}[t]{13.2cm} + \begin{enumerate} #2 \end{enumerate} + \vspace{1.3ex} +\end{minipage} +} \\ [1ex] \hline \\ [-1.5ex] } + +%------------------------------------------------------------------------------- +% \additemizedfield command: add a field with an item list +%------------------------------------------------------------------------------- +\newcommand\additemizedfield[2]{ + \begin{minipage}[t][][t]{3.5cm} + \textit{#1} + \vspace{1.3ex} + \end{minipage}% + & + \begin{minipage}[t][][t]{8.9cm} + \begin{itemize} #2 \end{itemize} + \vspace{1.5ex} + \end{minipage}\\ [1ex] \hline \\ [-1.5ex] } + +%------------------------------------------------------------------------------- +% Definition of the use case environment +%------------------------------------------------------------------------------- +\newenvironment{usecase}{\tabularhead} +{\end{longtable}} |
