IEEE-Design-Doc-Template/template.tex

% Use the report class, and include the IEEE titlepage style for correct styling
\documentclass[10pt,letter]{report}
\usepackage{IEEEtitlepage}

% Define properties of the document
\title{Document Title}
\subtitle{Subtitle here}
\author{First Author, Second Author}
\company{UNL}
\summary{This is the summary.}
\date{\today}
\version{1.0}

% Setup hyperref.  Make sure to change the fields as needed
\usepackage{hyperref}
\hypersetup{
  pdfauthor={First Author, Second Author},
  pdftitle={Title: Subtitle},
  pdfsubject={Subject of Project},
  pdflang={English},
  pdfkeywords={keywords,comma,seperated}}


% Include a couple of packages for graphic and figures
\usepackage{graphics}
\usepackage{graphicx}
\usepackage{morefloats}
\usepackage{tabularx}

% Change margins to 0.75 inches
\usepackage[margin=0.75in]{geometry}

% Use natbib for bibliographic reference
\usepackage{natbib}
\bibliographystyle{plainnat}

% Provide a bibliography file.  Edit as needed.
% See https://en.wikibooks.org/wiki/LaTeX/Bibliography_Management for more information.
\usepackage{filecontents}
\begin{filecontents}{bibliography.bib}
@book{diller1993,
	author = {Diller, Antoni},
	title = {{LaTeX} Line by Line: Tips and Techniques or Document Processing},
	publisher = {John Wiley \& Sons},
	year = {1993}
}

@book{knuth1973,
	author = {Knuth, Donald E},
	title = {The Art of Computer Programming},
	publisher = {Addison-Wesley Publishing Company},
	year = {1973}
}

@book{kopka2003,
	author = {Helmut Kopka and Patrick W Daily},
	title = {Guide to {LaTeX}},
	publisher = {Addison-Wesley Profesional},
	year = {2013}
}

@book{raymond2003,
	author = {Eric S Raymond},
	title = {The Art of UNIX Programming},
	publisher = {Addison-Wesley},
	year = {2003}
}

@book{ritchie1988,
	author = {Ritchie, Dennis M and Brian W Kernighan},
	title = {The C Programming Language},
	publisher = {Prentice Hall},
	year = {1988}
}
\end{filecontents}

\begin{document}

\maketitle

\section*{Revision History}
\label{sec:revisions}
\addcontentsline{toc}{chapter}{Revision History}


\begin{table}[h]
  \centering
  \begin{tabular}{c|c|c|r}
    \textbf{Version} & \textbf{Changes} & \textbf{Author} & \textbf{Date}\\
    \hline\hline
    1.0& The initial design document structure.&Your Name& YYYY-MM-DD\\
                     &&&\\
    \hline
  \end{tabular}
  \caption{Revision History}
  \label{tab:rev-hist}
\end{table}
\newpage

% Table of Contents
\tableofcontents
\newpage

% Optional List of Figures
% \listoffigures
% \newpage

% Optional List of Tables
% \listoftables
% \newpage

\chapter{Introduction}
\label{sec:introduction}

\section{Purpose of this Document}
\label{sec:purp-this-docum}

\section{Scope of the Project}
\label{sec:scope-project}

\section{Definitions, Acronyms and Abbreviations}
\label{sec:defin-acronyms-abbr}

\subsection{Definitions}
\label{sec:definitions}

\subsection{Abbreviations and Acronyms}
\label{sec:abbr-acronyms}

\chapter{Overall Design Description}
\label{sec:over-design-descr}

\section{Alternative Design Options}
\label{sec:altern-design-opti}

\chapter{Detailed Component Description}
\label{sec:deta-comp-descr}

\section{Database Design}
\label{sec:database-design}

\subsection{Component Testing Strategy}
\label{sec:db-comp-test-strat}

\section{Class/Entity Model}
\label{sec:classentity-model}

\subsection{Component Testing Strategy}
\label{sec:cem-comp-test-strat}

\section{Database Interface}
\label{sec:database-interface}

\subsection{Component Testing Strategy}
\label{sec:dbint-comp-test-strat}

\section{Design and Integration of Data Structures}
\label{sec:design-integr-data}

\subsection{Component Testing Strategy}
\label{sec:dids-comp-test-strat}

\section{Changes and Refactoring}
\label{sec:changes-refactoring}

\chapter{Additional Material}
\label{sec:additional-material}


% Include the bibliography
\nocite{*}                      % Comment this line out if you don't want all of your bibliography entries in the final document.
\bibliography{bibliography}     % Comment this line out if you don't have a bibliography.

\end{document}

%%% Local Variables:
%%% mode: latex
%%% TeX-master: t
%%% End: