Skip to content
Snippets Groups Projects
Commit 6511948b authored by W. Spencer Smith's avatar W. Spencer Smith
Browse files

Updates to checklists - start of lists for MG and MIS

parent 6d0d7fd2
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
BlankProjectTemplate/docs/Design/MG/MG-Checklist.tex 0 → 100644
+ 166
− 0
View file @ 6511948b
\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{MG 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 Follows writing checklist
\begin{todolist}
\item \LaTeX{} points
\item Structure
\item Spelling, grammar, attention to detail
\item Avoid low information content phrases
\item Writing style
\end{todolist}
\item Follows the template, all parts present
\begin{todolist}
\item Table of contents
\item Pages are numbered
\item Revision history included for major revisions
\item Sections from template are all present
\item Values of auxiliary constants are given (constants are used to improve
maintainability and to increase understandability)
\end{todolist}
\item Overall qualities of documentation
\begin{todolist}
\item No statement is repeated at the same level of abstraction (for instance
the scope should be more abstract than the assumptions, the goal statements
should be more abstract than the requirements, etc.)
\item Someone that meets the characteristics of the intended reader could
learn what they need to know
\item Someone that meets the characteristics of the intended reader could
verify all of the statement made in the SRS. That is, they do not have to
trust the SRS authors on any information.
\item Terminology, definitions, symbols, TMs and DDs can be given without
derivation, except possibly for a source (citation), but all GDs and IMs
should be derived/justified. At least check a representative sample for
this criteria.
\item SRS is unambiguous. At least check a representative sample.
\item SRS is consistent. At least check a representative sample.
\item SRS is validatable. At least check a representative sample.
\item SRS is abstract. At least check a representative sample.
\item SRS is traceable. At least check a representative sample.
\item Literal symbols (like numbers) do not appear, instead being
represented by SYMBOLIC\_CONSTANTS (constants are given in a table in the
Appendix)
\end{todolist}
\item Reference Material
\begin{todolist}
\item All units introduced are listed (searching the document can help look
for other units that may be present, but not listed)
\item Units listed are each used at least once (manually searching the
document is a quick way to check this)
\item The names of units named after people are in lower-case
\item All symbols used in the document are listed in the table of symbols
\item All symbols listed in the table of symbols are used in the document
\item All abbreviations/acronyms used in the document are listed in the
table of abbreviations/acronyms
\item All abbreviations/acronyms listed in the table of
abbreviations/acronyms are used in the document
\end{todolist}
\item Introduction
\begin{todolist}
\item Introductory blurb focuses on the problem domain
\item Introductory blurb Includes a ``roadmap''
\item ``Purpose of the Document'' discusses the documentation's purpose, not
the program's purpose
\item Scope of the requirements is an abstract version of the assumptions
\item Characteristics of the intended reader are not confused with the user
characteristics
\item Characteristics of the intended reader are unambiguous
\end{todolist}
\item General System Description
\begin{todolist}
\item System context includes a figure showing the relation between the
software system and external entities
\item User characteristics are unambiguous
\item User characteristics are specific
\item System constraints have an appropriate rationale (a constraint without a
reason for that constraint is likely making the SRS less abstract than it
should be)
\end{todolist}
\item Problem Description
\begin{todolist}
\item Each item of the physical system is identified and labelled
\item Goal statements are abstract
\item Goal statements use a minimal amount of technical language,
understandable by non-domain experts
\end{todolist}
\item Solution Characteristics Specification
\begin{todolist}
\item Each assumption is ``atomic'' (no explicit or implicit ``ands'')
\item Assumptions are a refinement of the scope
\item Each assumption is referenced at least once
\item A link exists between each chunk and anything that references it
\item The rationale is given for assumptions that require justification
\item The derivation of all GDs as refinements from other models is clear
\item The derivation of all IMs as refinements from other models is clear
\item All DD are used (referenced) by at least one other model
\item The IMs remain abstract
\item Input data constraints are given, with a rationale where appropriate
\item Properties of a correct solution are given
\end{todolist}
\item Functional Requirements
\begin{todolist}
\item IMs and (possibly) TMs and GMs are referenced as appropriate by the
requirements.
\item All requirements are validatable
\item All requirements are abstract
\item Requirements are traceable to where the required details are found in
the document
\end{todolist}
\item Nonfunctional Requirements
\begin{todolist}
\item NFRs are verifiable
\end{todolist}
\item Likely and Unlikely changes
\begin{todolist}
\item Likely changes are feasible to hide in the design
\end{todolist}
\item Traceability Matrices
\begin{todolist}
\item Traceability matrix is complete
\end{todolist}
\end{itemize}
\end{document}
BlankProjectTemplate/docs/SRS/SRS-Checklist.tex
+ 0
− 24
View file @ 6511948b
......@@ -40,33 +40,9 @@
\item Sections from template are all present
\item Values of auxiliary constants are given (constants are used to improve
maintainability and to increase understandability)
\end{todolist}
\item Grammar, spelling, presentation
\begin{todolist}
\item No spelling mistakes (use a spell checker!)
\item No grammar mistakes (review, ask someone else to review (at least a few
sections))
\item Paragraphs are structured well (clear topic sentence, cohesive)
\item Paragraphs are concise (not wordy)
\item No Low Information Content (LIC) phrases
(\href{https://www.webpages.uidaho.edu/range357/extra-refs/empty-words.htm}{List
of LIC phrases})
\item All hyperlinks work
\item Every figure has a caption
\item Every table has a heading
\item Symbolic names are used for quantities, rather than literal values
\end{todolist}
\item LaTeX
\begin{todolist}
\item Template comments (plt) do not show in the pdf version, either by
removing them, or by turning them off.
\item References and labels are used so that maintenance is feasible
\item Opening quotes are in the right direction `` and closing quotes are in
the right direction ''.
\end{todolist}
\item Overall qualities of documentation
\begin{todolist}
\item No statement is repeated at the same level of abstraction (for instance
......
BlankProjectTemplate/docs/Writing-Checklist.pdf
+ 0
− 0
View file @ 6511948b
No preview for this file type
BlankProjectTemplate/docs/Writing-Checklist.tex
+ 31
− 8
View file @ 6511948b
......@@ -6,6 +6,15 @@
\usepackage{amsfonts}
\usepackage{amsmath}
\usepackage{hyperref}
\hypersetup{colorlinks=true,
linkcolor=blue,
citecolor=blue,
filecolor=blue,
urlcolor=blue,
unicode=false}
\urlstyle{same}
\newlist{todolist}{itemize}{2}
\setlist[todolist]{label=$\square$}
\usepackage{pifont}
......@@ -28,13 +37,7 @@
\begin{itemize}
\item Avoid Low Information Content phrases
\begin{todolist}
\item ``in order to'' simplified to ``to''
\item ...
\end{todolist}
\item \LaTeX points
\item \LaTeX{} points
\begin{todolist}
\item Only tex file (and possibly pdf files, or image files) are under version
control.
......@@ -48,6 +51,9 @@
tex files. Please be sure to include the Comments.tex file in your repo and
in your tex files.
\item Text should be 80 characters wide.
\item Template comments (plt) do not show in the pdf version, either by
removing them, or by turning them off.
\item References and labels are used so that maintenance is feasible
\end{todolist}
\item Structure
......@@ -65,17 +71,34 @@
\item Parentheses (brackets) occur in pairs, one opening and one closing
\item All sentences begin with a capital letter.
\item Document is spell checked!
\item Grammar has been checked.
\item Grammar has been checked (review, ask someone else to review (at least a few
sections)).
\item Symbols used outside of a formula should be formatted the same way as
they are in the equation. For instance, when listing the variables in an
equation, you should still use math mode for the symbols.
\item Include a .gitignore file in your repo so that generated files are
ignored by git
\item All hyperlinks work
\item Every figure has a caption
\item Every table has a heading
\end{todolist}
\item Avoid Low Information Content phrases
(\href{https://www.webpages.uidaho.edu/range357/extra-refs/empty-words.htm}{List
of LIC phrases})
\begin{todolist}
\item ``in order to'' simplified to ``to''
\item ...
\end{todolist}
\item Writing style
\begin{todolist}
\item Avoid sentences that start with ``It.''
\item Paragraphs are structured well (clear topic sentence, cohesive)
\item Paragraphs are concise (not wordy)
\end{todolist}
\end{itemize}
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment