Final revisions of L19

Lectures/L19_AssuranceCase/AssuranceCase.tex

@@ -71,7 +71,7 @@
 \item L23--24 --- Implementation/Testing Presentations
 \item L25 --- Discussion
 \ei
-\item No requirement to provide feedback on final documentation
+\item No requirement to provide feedback to colleagues on final documentation
 \ei
 
 \end{frame}
@@ -112,6 +112,7 @@ requirement and trace it all the way to testing
 \ei
 \item Make it easy to see changes from Rev 0
 \bi
+\item \href{https://github.com/smiths/capTemplate/tree/main/docs/Reflection} {Reflection document}
 \item Closed issues in the issue tracker
 \item Specific explanation in Revision History
 \item Comments in tex file
@@ -124,18 +125,52 @@ requirement and trace it all the way to testing
 \begin{frame}
 \frametitle{Final Documentation}
 \begin{itemize}
+\item Problem Statement revised and improved
 \item Requirements Document revised and improved
 \item Design Documents revised and improved
-\item VnV Plan revised and improved, unit tests added (can point to test code)
+\item VnV Plan revised and improved (complete unit testing sections)
+\begin{itemize}
+  \item Summarize unit testing philosophy
+  \item Point to unit testing code
+\end{itemize}
 \item VnV Report
 \item Source Code
 \item Drasil projects no longer need to maintain the traditionally generated SRS
-\item Discuss Reflection document
+\item \href{https://github.com/smiths/capTemplate/tree/main/docs/Reflection} {Reflection Document}
 \end{itemize}
 \end{frame}
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
+\begin{frame}
+\frametitle{Final Doc: Reflection}
+\begin{itemize}
+\item Reflection document updated in
+\href{https://github.com/smiths/capTemplate/tree/main/docs/Reflection}
+{capTemplate repo}
+
+\item Summarize changes in response to feedback from reviewers,
+instructor, supervisor, users
+\item Explain how you arrived at your final design and implementation
+\item Reflect on and justify your design decisions
+\item Ignore questions related to:
+\begin{itemize}
+  \item Hazard analysis
+  \item Economic considerations
+\end{itemize}
+\item How did your project management compare to your dev plan
+\begin{itemize}
+  \item What went well? (continue)
+  \item What went wrong? (stop)
+  \item What would you do differently next time? (start)
+\end{itemize}
+% \item Applies the principles of equity and universal design to ensure equitable
+% treatment of all stakeholders
+\end{itemize}
+\end{frame}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 \begin{frame}
 \frametitle{Final Project Quality}
 \begin{itemize}
@@ -189,7 +224,7 @@ requirement and trace it all the way to testing
 \item Your approach for automated testing (if not already covered)
 \item Tools for code coverage metrics (if not already covered)
 \item Non-testing based verification (if planned)
-\item Unit test cases for each module - from black box and white box
+\item Unit test cases for each module - from black box and white box (can point to code)
 \item Performance tests for individual modules (if appropriate)
 \item Evidence that all modules are considered
 \end{itemize}
@@ -282,7 +317,12 @@ requirement and trace it all the way to testing
   \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}
+  \href{https://gitlab.cas.mcmaster.ca/courses/capstone/-/tree/main/SamplesOfStudentWork/VnVReport}
+  {Capstone Sample reports}
+\item \href{https://github.com/smiths/swhs/tree/master/docs/VnVReport} 
+{Solar Water Heating System}
+\item
+  \href{https://github.com/smiths/capTemplate}
   {Follow given template}
 \item Examples are not perfect
 \item Examples are intended to give you ideas, not to be strictly followed
@@ -334,7 +374,7 @@ requirement and trace it all the way to testing
 \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 Your decisions on style may evolve over the project
 \item Important to be consistent
 \ei
 
@@ -352,6 +392,7 @@ requirement and trace it all the way to testing
 \item
   \href{https://gitlab.cas.mcmaster.ca/smiths/se2aa4_cs2me3/-/tree/master/Tutorials/T01b-Doxygen}
   {Tutorial on Doxygen} 
+\item There are alternative to doxygen (pydoc, javadoc, sphinx, etc.)
 \ei
 
 \end{frame}
@@ -447,27 +488,27 @@ requirement and trace it all the way to testing
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
-\begin{frame}
-\frametitle{GNU Questions}
+% \begin{frame}
+% \frametitle{GNU Questions}
 
-\bi
-\item Question 1
-\bi
-\item You modify some Linux source files to install Linux on your embedded
-  device
-\item You write software to run on this new Linux ``box''
-\item What software falls under the GPL?
-\item \href{http://www.softwarefreedom.org/resources/2008/compliance-guide.html}{Answer}
-\ei
-\item Question 2
-\bi
-\item You want to distribute object code compiled by gcc, where gcc is under GPL
-\item Is your object code under GPL?
-\item \href{https://www.gnu.org/licenses/gcc-exception-3.1-faq.en.html}{Answer}
-\ei
-\ei
+% \bi
+% \item Question 1
+% \bi
+% \item You modify some Linux source files to install Linux on your embedded
+%   device
+% \item You write software to run on this new Linux ``box''
+% \item What software falls under the GPL?
+% \item \href{http://www.softwarefreedom.org/resources/2008/compliance-guide.html}{Answer}
+% \ei
+% \item Question 2
+% \bi
+% \item You want to distribute object code compiled by gcc, where gcc is under GPL
+% \item Is your object code under GPL?
+% \item \href{https://www.gnu.org/licenses/gcc-exception-3.1-faq.en.html}{Answer}
+% \ei
+% \ei
 
-\end{frame}
+% \end{frame}
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
@@ -522,6 +563,30 @@ requirement and trace it all the way to testing
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
+\begin{frame}
+\frametitle{Other Potential Files in Your Project}
+
+\bi
+\item README
+\item Contributing guidelines
+\item Citation
+\item Changelog
+\item Install/Uninstall
+\item Dependency list
+\item Authors
+\item Code of conduct
+\item Acknowledgements
+\item Style guide
+\item Release information
+\item Product roadmap
+\item Getting started guide, user manual, tutorials
+\item FAQ
+\ei
+
+\end{frame}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 \begin{frame}
 \frametitle{Code of Conduct}
 
@@ -540,10 +605,13 @@ requirement and trace it all the way to testing
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \begin{frame}
-\frametitle{Other Files in CapTemplate}
+\frametitle{README files}
 
 \bi
-\item LBM table?
+\item Make sure the README file on your landing page is up to date
+\item \href{https://arxiv.org/abs/1802.06997} {Categories and Contents of README files}
+\item A README file is useful in any folder
+\item Give the reader information on the contents of the folder
 \ei
 
 \end{frame}
@@ -551,7 +619,7 @@ requirement and trace it all the way to testing
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \begin{frame}
-\frametitle{Assurance Cases in Scientific Computing \cite{SmithEtAl2018_ICSEPoster}}
+\frametitle{Assurance Cases in Scientific Computing \cite{SmithEtAl2020,SmithEtAl2018_ICSEPoster}}
 
 \bi
 \item Assurance cases