Additional information on test report, installability, src folder, coding style

BlankProjectTemplate/Doc/TestReport/TestReport.tex

@@ -12,29 +12,20 @@
 }
 \usepackage[round]{natbib}
 
-\title{SE 3XA3: Test Report\\Title of Project}
-
-\author{Team \#, Team Name
-		\\ Student 1 name and macid
-		\\ Student 2 name and macid
-		\\ Student 3 name and macid
-}
-
-\date{\today}
-
 \input{../Comments}
 
 \begin{document}
 
+\title{Test Report: Project Title} 
+\author{Author Name}
+\date{\today}
+	
 \maketitle
 
 \pagenumbering{roman}
-\tableofcontents
-\listoftables
-\listoffigures
 
-\begin{table}[bp]
-\caption{\bf Revision History}
+\section{Revision History}
+
 \begin{tabularx}{\textwidth}{p{3cm}p{2cm}X}
 \toprule {\bf Date} & {\bf Version} & {\bf Notes}\\
 \midrule
@@ -42,7 +33,29 @@ Date 1 & 1.0 & Notes\\
 Date 2 & 1.1 & Notes\\
 \bottomrule
 \end{tabularx}
-\end{table}
+
+~\newpage
+
+\section{Symbols, Abbreviations and Acronyms}
+
+\renewcommand{\arraystretch}{1.2}
+\begin{tabular}{l l} 
+  \toprule		
+  \textbf{symbol} & \textbf{description}\\
+  \midrule 
+  T & Test\\
+  \bottomrule
+\end{tabular}\\
+
+\wss{symbols, abbreviations or acronyms -- you can reference the SRS tables if needed}
+
+\newpage
+
+\tableofcontents
+
+\listoftables %if appropriate
+
+\listoffigures %if appropriate
 
 \newpage
 

BlankProjectTemplate/src/INSTALL.txt

+Instructions for installation and running of software.
\ No newline at end of file

Lectures/L22_AssuranceCase/AssuranceCase.tex

@@ -168,12 +168,13 @@
 \begin{frame}
 \frametitle{Final Documentation: Source Code}
 \begin{itemize}
+\item Source code in src folder
 \item Comments on ``what'' not ``how''
 \item Identifiers that are consistent, distinctive, and meaningful
 \item Avoidance of hard-coded constants (other than maybe 0 and 1)
 \item Appropriate modularization
 \item Consistent indentation
-\item Explicit identification of coding standards
+\item Explicit identification of coding standards (see next slide)
 \item Parameters are in the same order for all functions
 \item Descriptive names of source code files
 \item Traceability to modules in module guide
@@ -182,6 +183,50 @@
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
+\begin{frame}
+\frametitle{Coding Style}
+
+\bi
+\item Having a coding standard is more important than which standard you use
+\item Examples
+\bi
+\item Google guides
+\bi
+\item \href{https://google.github.io/styleguide/pyguide.html}{Python}
+\item \href{https://google.github.io/styleguide/cppguide.html}{C++}
+\item \href{https://google.github.io/styleguide/javaguide.html}{Java}
+\ei
+\item
+  \href{https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Coding_Style}{Mozilla
+    Developer Network}
+\item \href{http://homepages.inf.ed.ac.uk/dts/pm/Papers/nasa-c-style.pdf}{NASA C
+    Style Guide}
+\ei
+\item Your decisions on style may evolve over the project
+\item Important to be consistent
+\ei
+
+\end{frame}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\begin{frame}
+\frametitle{Installability and Learnability}
+
+\bi
+\item You can test this
+\item Ask a colleague to install your software
+\item Run it on a virtual machine, like
+  \href{https://www.virtualbox.org/}{VirtualBox}
+\item Use a ``light weight'' VM like docker
+\item Include installation instructions (INSTALL.txt)
+\item Include instructions so that someone else can run your tests cases
+\ei
+
+\end{frame}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 \begin{frame}
 \frametitle{Final Documentation}
 \begin{itemize}
@@ -199,6 +244,99 @@
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
+\begin{frame}
+\frametitle{Final Documentation: Test Report}
+\begin{itemize}
+\item Completing what you proposed in your test plan
+\item You do not need to repeat material from your test plan - the emphasis is
+  not on the rational for test case selection, but on the results.
+\item If your test plan does not match what you are now testing, edit your test
+  plan to ``fake'' a rational design process.
+\end{itemize}
+\end{frame}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\begin{frame}
+\frametitle{Test Report Continued}
+\begin{itemize}
+\item Provide specific test cases
+\item Summarize your test results
+\bi
+\item Test case name
+\item Initial state
+\item Input
+\item Expected results
+\item Whether actual output matched expected
+\ei
+\item Summarize and explain usability tests - quantify the results
+\item Performance tests - quantify the results
+\item Stress tests
+\item Robustness tests
+\item After quantification of nonfunctional tests, explain significance of
+  results
+\end{itemize}
+\end{frame}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\begin{frame}
+\frametitle{Test Report Continued}
+\begin{itemize}
+\item In cases where there are many similar tests
+\bi
+\item Summarize the results
+\item If the expected result is obvious, you might not need to state it
+\item Give an example test case, and explain how similar tests were constructed
+\item If the tests were random, describe how they were selected, and how many,
+  but not all of the details
+\item Use graphs and tables
+\item You need enough information that
+\bi
+\item Someone could reproduce your tests
+\item Your test results are convincing
+\item Evidence that you have used testing to improve the quality of your project
+\ei
+\ei
+\end{itemize}
+\end{frame}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\begin{frame}
+\frametitle{Test Report Continued}
+\begin{itemize}
+\item Summarize changes made in response to test results
+\item Explain your automated testing set-up (if require more detail than from
+  the test plan)
+\item Provide traceability to requirements
+\item Provide traceability to modules
+\item Make sure you show test results for ``bad/abnormal'' input
+\end{itemize}
+\end{frame}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\begin{frame}
+\frametitle{Sample Test Report Documents} 
+
+\bi
+\item
+  \href{https://gitlab.cas.mcmaster.ca/screenholders/screenholders}{Screenholders}
+\item
+  \href{https://github.com/palmerst/CS-4ZP6/tree/master}{2D Physics Based Game}
+  (Uses doxygen)
+\item
+  \href{https://gitlab.cas.mcmaster.ca/smiths/cas741/tree/master/BlankProjectTemplate/Doc/TestReport}{Follow given template}
+\item Examples are not perfect
+\item Examples are intended to give you ideas, not to be strictly followed
+\item You can modify/extend the test report template as appropriate
+\ei
+
+\end{frame}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 \begin{frame}
 \frametitle{Questions?}
 \begin{itemize}

Lectures/L25_Discussion/Discussion.tex

@@ -43,6 +43,8 @@
 
 \bi
 \item Administrative details
+\item Coding style
+\item Test report
 \item Questions?
 \item Discussion
 \ei
@@ -67,6 +69,8 @@
 \item Grading as before
 \item Due by Tuesday, Dec 5, 11:59 pm
 \ei
+\item Source in src folder
+\item Added an INSTALL.txt file to BlankProjectTemplate
 \ei
 
 \end{frame}
@@ -76,14 +80,151 @@
 \begin{frame}
 \frametitle{Administrative Details: Deadlines}
 ~\newline
-\begin{tabular}{l l l}
-\textbf{Final Documentation} & Week 13 & Dec 6\\
+\begin{tabular}{l l}
+\textbf{Final Documentation} & Dec 18, 11:59 pm\\
 \end {tabular}
 
 \end{frame}
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
+\begin{frame}
+\frametitle{Coding Style}
+
+\bi
+\item Having a coding standard is more important than which standard you use
+\item Examples
+\bi
+\item Google guides
+\bi
+\item \href{https://google.github.io/styleguide/pyguide.html}{Python}
+\item \href{https://google.github.io/styleguide/cppguide.html}{C++}
+\item \href{https://google.github.io/styleguide/javaguide.html}{Java}
+\ei
+\item
+  \href{https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Coding_Style}{Mozilla
+    Developer Network}
+\item \href{http://homepages.inf.ed.ac.uk/dts/pm/Papers/nasa-c-style.pdf}{NASA C
+    Style Guide}
+\ei
+\item Your decisions on style may evolve over the project
+\item Important to be consistent
+\ei
+
+\end{frame}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\begin{frame}
+\frametitle{Installability and Learnability}
+
+\bi
+\item You can test this
+\item Ask a colleague to install your software
+\item Run it on a virtual machine, like
+  \href{https://www.virtualbox.org/}{VirtualBox}
+\item Use a ``light weight'' VM like docker
+\item Include installation instructions (INSTALL.txt)
+\item Include instructions so that someone else can run your tests cases
+\ei
+
+\end{frame}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\begin{frame}
+\frametitle{Final Documentation: Test Report}
+\begin{itemize}
+\item Completing what you proposed in your test plan
+\item You do not need to repeat material from your test plan - the emphasis is
+  not on the rational for test case selection, but on the results.
+\item If your test plan does not match what you are now testing, edit your test
+  plan to ``fake'' a rational design process.
+\end{itemize}
+\end{frame}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\begin{frame}
+\frametitle{Test Report Continued}
+\begin{itemize}
+\item Provide specific test cases
+\item Summarize your test results
+\bi
+\item Test case name
+\item Initial state
+\item Input
+\item Expected results
+\item Whether actual output matched expected
+\ei
+\item Summarize and explain usability tests - quantify the results
+\item Performance tests - quantify the results
+\item Stress tests
+\item Robustness tests
+\item After quantification of nonfunctional tests, explain significance of
+  results
+\end{itemize}
+\end{frame}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\begin{frame}
+\frametitle{Test Report Continued}
+\begin{itemize}
+\item In cases where there are many similar tests
+\bi
+\item Summarize the results
+\item If the expected result is obvious, you might not need to state it
+\item Give an example test case, and explain how similar tests were constructed
+\item If the tests were random, describe how they were selected, and how many,
+  but not all of the details
+\item Use graphs and tables
+\item You need enough information that
+\bi
+\item Someone could reproduce your tests
+\item Your test results are convincing
+\item Evidence that you have used testing to improve the quality of your project
+\ei
+\ei
+\end{itemize}
+\end{frame}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\begin{frame}
+\frametitle{Test Report Continued}
+\begin{itemize}
+\item Summarize changes made in response to test results
+\item Explain your automated testing set-up (if require more detail than from
+  the test plan)
+\item Provide traceability to requirements
+\item Provide traceability to modules
+\item Make sure you show test results for ``bad/abnormal'' input
+\end{itemize}
+\end{frame}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\begin{frame}
+\frametitle{Sample Test Report Documents} 
+
+\bi
+\item
+  \href{https://gitlab.cas.mcmaster.ca/screenholders/screenholders}{Screenholders}
+\item
+  \href{https://github.com/palmerst/CS-4ZP6/tree/master}{2D Physics Based Game}
+  (Uses doxygen)
+\item
+  \href{https://gitlab.cas.mcmaster.ca/smiths/cas741/tree/master/BlankProjectTemplate/Doc/TestReport}{Follow given template}
+\item Examples are not perfect
+\item Examples are intended to give you ideas, not to be strictly followed
+\item You can modify/extend the test report template as appropriate
+\ei
+
+\end{frame}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 \begin{frame}
 \frametitle{Questions?}
 \begin{itemize}