Skip to content

Commit

Permalink
Resolved issue with enumitem package dependency.
Browse files Browse the repository at this point in the history
  • Loading branch information
applebyter committed Apr 30, 2024
1 parent 0a8f99d commit 9eb6f0e
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 12 deletions.
20 changes: 10 additions & 10 deletions notes/adr/content.tex
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ \section{Introduction}

Architecture decision records should capture important decisions that are made about the design of the architecture.
These include decisions that influence the
\begin{itemize}[noitemsep,nolistsep]
\begin{itemize}[topsep=0pt,noitemsep]
\item structure of the architecture,
\item delivery of quality attributes,
\item dependencies between key parts of the architecture,
Expand Down Expand Up @@ -47,7 +47,7 @@ \section{Introduction}
It is recommended that the file name describe the decision,
to make it easier to scan for information about specific types of architectural decisions.
Examples of meaningful file names include:
\begin{itemize}[noitemsep,nolistsep]
\begin{itemize}[topsep=0pt,noitemsep]
\item \texttt{0001-independent-business-logic.md}
\item \texttt{0002-implement-JSF-webapp.md}
\item \texttt{0003-choose-database.md}
Expand Down Expand Up @@ -86,11 +86,11 @@ \section{ADR Example}
\emph{accepting} potential complexity of interfaces to different platforms.

\noindent\textbf{Context}
\begin{itemize}[noitemsep,nolistsep]
\begin{itemize}[topsep=0pt,noitemsep]
\item The system is to have both mobile and web application frontends.
\item Marketing department wants a similar user experience across platforms.
\item Delivering functional requirements requires complex processing and database transactions.
\begin{itemize}[noitemsep,nolistsep]
\begin{itemize}[topsep=0pt,noitemsep]
\item Product recommendations based on both a customer's history and on purchasing behaviour of similar customers.
\item Recording all customer interactions in the application.
\end{itemize}
Expand All @@ -108,27 +108,27 @@ \section{ADR Example}

The business logic will be implemented in Java.
This suits the current development team's experience and is a common environment.
Java has good performance characteristices.
Java has good performance characteristics.
Java has good support for interacting with databases, to deliver the data storage and transaction processing requirements.

\filbreak
\noindent\textbf{Consequences}\\
Advantages
\begin{itemize}[noitemsep,nolistsep]
\begin{itemize}[topsep=0pt,noitemsep]
\item Separation of concerns, keeping application logic and interface logic separate.
\item Ensures consistency, if business logic is only implemented in one place.
\item Business logic can execute in a computing environment optimised for processing and transactions.
\begin{itemize}[noitemsep,nolistsep]
\begin{itemize}[topsep=0pt,noitemsep]
\item Also makes load balancing easier to implement.
\end{itemize}
\end{itemize}
Neutral
\begin{itemize}[noitemsep,nolistsep]
\begin{itemize}[topsep=0pt,noitemsep]
\item Multiple interfaces are required for different frontend applications.
These can be delivered through different Java libraries.
\end{itemize}
Disadvantages
\begin{itemize}[noitemsep,nolistsep]
\begin{itemize}[topsep=0pt,noitemsep]
\item Additional complexity for the overall architecture of the system.
\end{itemize}

Expand Down Expand Up @@ -186,7 +186,7 @@ \section{What to Put in an ADR?}
non-functional characteristics, dependencies, interfaces, or construction techniques.
Michael Nygard calls these ``architecturally significant'' decisions \cite{nygard-adr}.
The types of decisions that usually should be documented are:
\begin{itemize}[noitemsep,nolistsep]
\begin{itemize}[noitemsep]
\item Critical or important to delivering system functionality.
\item Helps deliver important quality attributes.
\item Unconventional or risky approach to a solution.
Expand Down
1 change: 0 additions & 1 deletion notes/adr/main.tex
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
\usepackage{subcaption}
\usepackage{changepage}
\usepackage{enumitem}

\usepackage{languages}

\begin{document}
Expand Down
2 changes: 2 additions & 0 deletions notes/distributed3/main.tex
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
\author{Richard Thomas}
\date{\week{10}}

\usepackage{enumitem}

\begin{document}

\makecover
Expand Down
1 change: 0 additions & 1 deletion tex/csse4400.cls
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
\RequirePackage{common}
\RequirePackage{enumitem}

\NeedsTeXFormat{LaTeX2e}
\ProvidesClass{csse4400}[2022/01/01 \thecourse]
Expand Down

0 comments on commit 9eb6f0e

Please sign in to comment.