Skip to content

Commit

Permalink
Minor fixes to SRS template
Browse files Browse the repository at this point in the history
  • Loading branch information
smiths committed Jan 3, 2025
1 parent 8ed4dff commit 33fc398
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions docs/SRS/SRS.tex
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ \section*{Revision History}
should be used exactly as given, except the Reflection Appendix can be deleted.
For the capstone course it is a source of ideas, but shouldn't be followed
exactly. The exception is the reflection appendix. All capstone SRS documents
should have a refelection appendix.}
should have a reflection appendix.}

~\newpage

Expand Down Expand Up @@ -471,7 +471,6 @@ \subsection{System Context}
the Automotive Safety Integrity Levels (ASILs) that McSCert uses in their
automotive hazard analyses.}

\wss{The }
\subsection{User Characteristics} \label{SecUserCharacteristics}

\plt{This section summarizes the knowledge/skills expected of the user.
Expand Down Expand Up @@ -660,8 +659,11 @@ \subsubsection{Assumptions} \label{sec_assumpt}
\plt{The document should not take for granted that the reader knows which
assumptions have been made. In the case of unusual assumptions, it is
recommended that the documentation either include, or point to, an explanation
and justification for the assumption.}
\plt{If it helps with the organization and understandability, the assumptions can be presented as sub sections. The following sub-sections are options: background theory assumptions, helper theory assumptions, generic theory assumptions, problem specific assumptions, and rationale assumptions}
and justification for the assumption.}
\plt{If it helps with the organization and understandability, the assumptions
can be presented as sub sections. The following sub-sections are options:
background theory assumptions, helper theory assumptions, generic theory
assumptions, problem specific assumptions, and rationale assumptions}

This section simplifies the original problem and helps in developing the
theoretical model by filling in the missing information for the physical system.
Expand All @@ -687,7 +689,11 @@ \subsubsection{Theoretical Models}\label{sec_theoretical}
(Section~\ref{sec_phySystDescrip}). Examples of theoretical models are
physical laws, constitutive equations, relevant conversion factors, etc.}

\plt{Optionally the theory section could be divided into subsections to provide more structure and improve understandability and reusability. Potential subsections include the following: Context theories, background theories, helper theories, generic theories, problem specific theories, final theories and rationale theories.}
\plt{Optionally the theory section could be divided into subsections to provide
more structure and improve understandability and reusability. Potential
subsections include the following: Context theories, background theories, helper
theories, generic theories, problem specific theories, final theories and
rationale theories.}

This section focuses on the general equations and laws that \progname{} is based
on. \plt{Modify the examples below for your problem, and add additional models
Expand Down

0 comments on commit 33fc398

Please sign in to comment.