diff --git a/BlankProjectTemplate/docs/ProblemStatement/ProbState-Checklist.pdf b/BlankProjectTemplate/docs/ProblemStatement/ProbState-Checklist.pdf new file mode 100644 index 0000000000000000000000000000000000000000..34328c42164319c2447ff56086b4d48f7edd51a4 Binary files /dev/null and b/BlankProjectTemplate/docs/ProblemStatement/ProbState-Checklist.pdf differ diff --git a/BlankProjectTemplate/docs/ProblemStatement/ProbState-Checklist.tex b/BlankProjectTemplate/docs/ProblemStatement/ProbState-Checklist.tex new file mode 100644 index 0000000000000000000000000000000000000000..91c20cd7c954d47c2190df6961245ba815ded68f --- /dev/null +++ b/BlankProjectTemplate/docs/ProblemStatement/ProbState-Checklist.tex @@ -0,0 +1,74 @@ +\documentclass[12pt]{article} + +\usepackage{hyperref} +\hypersetup{colorlinks=true, + linkcolor=blue, + citecolor=blue, + filecolor=blue, + urlcolor=blue, + unicode=false} +\urlstyle{same} + +\usepackage{enumitem,amssymb} +\newlist{todolist}{itemize}{2} +\setlist[todolist]{label=$\square$} +\usepackage{pifont} +\newcommand{\cmark}{\ding{51}}% +\newcommand{\xmark}{\ding{55}}% +\newcommand{\done}{\rlap{$\square$}{\raisebox{2pt}{\large\hspace{1pt}\cmark}}% +\hspace{-2.5pt}} +\newcommand{\wontfix}{\rlap{$\square$}{\large\hspace{1pt}\xmark}} + +\begin{document} + +\title{Problem Statement Checklist} +\author{Spencer Smith} +\date{\today} + +\maketitle + +% Show an item is done by \item[\done] Frame the problem +% Show an item will not be fixed by \item[\wontfix] profit + +\begin{itemize} + +\item Uses the provided \texttt{tex} file as a base + \begin{todolist} + \item Includes the input for \texttt{Comments} + \item Includes a title + \item Revision history included for major revisions + \end{todolist} + +\item Follows writing checklist (full checklist provided in a separate document) + \begin{todolist} + \item \LaTeX{} points + \item Structure + \item Spelling, grammar, attention to detail + \item Avoid low information content phrases + \item Writing style + \item Use of \texttt{.gitignore} file + \item Hard-wrap at 80 characters per line + \end{todolist} + +\item Overall qualities of documentation + \begin{todolist} + \item Scope is clear + \item Document is abstract (for instance, it does not mention the programming + language (unless this is a true constraint) or the numerical algorithm + choice (unless the algorithm is the ``what'' rather than the ``how'')) + \item Output of software is unambiguous + \item Inputs to software are unambiguous + \item Problem statement points to Drasil, if this is to be a project + implemented with Drasil +\end{todolist} + +\item Problem statement review issue is created correctly + \begin{todolist} + \item Issue includes a link the file to be reviewed, or the commit hash where + the latest version is found + \item Issue is assigned to \texttt{smiths} +\end{todolist} + +\end{itemize} + +\end{document}