diff --git a/6047cem_report_template.tex b/6047cem_report_template.tex index be222ad..197228a 100644 --- a/6047cem_report_template.tex +++ b/6047cem_report_template.tex @@ -140,7 +140,7 @@ % Abstract of your project \thispagestyle{empty} \begin{abstract} - \lipsum[2-4] + \input{chapters/0_Abstract} \end{abstract} \clearpage @@ -163,8 +163,8 @@ % Beginning of the Report - %% Introduction Chapter -% \input{chapters/1_Introduction.tex} + % Introduction Chapter + \input{chapters/1_Introduction.tex} % Literature Review \input{chapters/2_LiteratureReview.tex} @@ -179,8 +179,8 @@ % Discussion \input{chapters/5_Discussion.tex} - %% Project Management -% \input{chapters/6_ProjectManagement.tex} + % Project Management + \input{chapters/6_ProjectManagement.tex} % Conclusion \input{chapters/7_Conclusion.tex} diff --git a/chapters/0_Abstract.tex b/chapters/0_Abstract.tex new file mode 100644 index 0000000..b266e2b --- /dev/null +++ b/chapters/0_Abstract.tex @@ -0,0 +1,14 @@ +\section*{Guidelines for this Chapter}\label{sec:introduction-guidelines} +\textbf{\color{red}{This is not a section in your report, but will give you some tips and guidance on what you should be +including in your abstract.}} + +\begin{itemize} + \item {Provide an overview of the project \textbf{as a whole} + \begin{itemize} + \item {start by introducing the project and what it is} + \item {discuss the methodology you have followed in brief} + \item {provide a mini-conclusion on the findings from your work} + \end{itemize} + } + \item {Should not exceed more than one-sheet of A4 and two to three paragraphs at max} +\end{itemize} \ No newline at end of file diff --git a/chapters/1_Introduction.tex b/chapters/1_Introduction.tex index 5718ec6..e7a8448 100644 --- a/chapters/1_Introduction.tex +++ b/chapters/1_Introduction.tex @@ -1,8 +1,54 @@ \chapter{Introduction}\label{ch:introduction} -\lipsum[2-5]~\citep{cornelius22} + +\section*{Guidelines for this Chapter}\label{sec:introduction-guidelines} +\textbf{\color{red}{This is not a section in your report, but will give you some tips and guidance on what you should be +including in your introduction.}} +\begin{itemize} + \item {Provide a discussion as to why your project is important + \begin{itemize} + \item {introduce the background to the problem} + \item {provide some statistics from reputable sites to give credit to why this project is important} + \end{itemize} + } + \item {Discuss the motivation behind your project + \begin{itemize} + \item {why is it important?} + \item {how does this align to the course you are studying?} + \end{itemize} + } + \item {Provide your research questions + \begin{itemize} + \item {list them as bullet points} + \item {provide a sub-section on aims and objectives in order to meet answering these questions} + \end{itemize} + } +\end{itemize} + \section{Research Motivation}\label{sec:research-motivation} -\lipsum[2-5] -\section{Aims and Objects}\label{sec:aims-and-objects} -\lipsum[2-5] -\section{Structure of the Report}\label{sec:structure-of-the-report} -\lipsum[2-5] \ No newline at end of file +\begin{itemize} + \item {Discuss the motivation behind your project + \begin{itemize} + \item {why is it important?} + \item {how does this align to the course you are studying?} + \end{itemize} + } +\end{itemize} + +\section{Research Question(s)/Hyptoheses}\label{sec:introduction-research-questions} +\begin{itemize} + \item {Provide your research question(s) as bullet points} +\end{itemize} + +\subsection{Aims and Objectives}\label{sec:introduction-research-questions-aims-and-objectives} +\begin{itemize} + \item {Paraphrase the aims and objectives in order to meet answering your research question(s)} +\end{itemize} + +\section{Structure of the Report}\label{sec:introduction-structure-of-the-report} +\begin{itemize} + \item {Provide an outline of the overall dissertation report + \begin{itemize} + \item {discuss each chapter heading and what you will be presenting in that chapter} + \end{itemize} + } +\end{itemize} \ No newline at end of file diff --git a/chapters/2_LiteratureReview.tex b/chapters/2_LiteratureReview.tex index 4adc261..59a0aba 100644 --- a/chapters/2_LiteratureReview.tex +++ b/chapters/2_LiteratureReview.tex @@ -1,48 +1,52 @@ \chapter{Literature Review}\label{ch:literature-review} \section*{Guidelines for this Chapter}\label{sec:lit_rev_guidelines} -This is not a section in your report, but will give you some tips and guidance on what you should be including in -your literature review. +\textbf{\color{red}{This is not a section in your report, but will give you some tips and guidance on what you should be + including in your literature review.}} \begin{itemize} - \item {Show the connections between your sources + \item {Show connections between the literature you have reviewed \begin{itemize} - \item {do not provide a list of papers with a brief description} - \item {provide a narrative on work undertaken for a particular field} - \item {show how the literature has contributed towards the current research and find connections between them} + \item {do not provide a list of papers with a brief description of the authors work} + \item {provide a narrative on the work that has been undertaken within that field} + \item {show how the literature has contributed towards the current research and find connections between + them} \end{itemize} } \item {Be critical with the literature you are reviewing \begin{itemize} \item {do not provide just a description of the authors work} - \item {evaluate the authors work and answer the following questions: - \begin{itemize} + \item {evaluate the authors work and answer the following: + \begin{enumerate} \item {do they make a good argument?} - \item {are there flaws in their methodology?} - \item {is there any issues they have failed to address} - \end{itemize} + \item {are there any flaws in their methodology?} + \item {are there any issues that they have failed to address?} + \end{enumerate} } - \item {try and compare their strenghts and weaknesses} + \item {try and compare their strengths and weaknesses} \end{itemize} } - \item {Signpost throughout the discussion to ensure the reader follows your narative + \item {Signpost through your discussion to ensure that reader follows your narrative \begin{itemize} - \item {relate your discussion back to your research topic and what \textbf{you} are doing} + \item {relate your discussion back to the research topic and what \textit{you} are doing} \end{itemize} } \item {Provide a clear argument \begin{itemize} \item {present your own understanding of the topic area} - \item {be careful and selective with the literature you choose to review} - \item {control how you present the work to the reader} + \item {be careful and selective with the literature you choose to review + \begin{itemize} + \item {control how you present this work to the reader} + \end{itemize} + } \end{itemize} } - \item {Chapter should be structured by themes (known as a thematic structure) + \item {Your discussion should be structured by themes, known as a thematic structure) \begin{itemize} - \item {literature is organised into sections by theme, this is a particular subtopic or focus} + \item {organise your literature into sections by a particular topic or focus} \item {sections are arranged in the most logical order \begin{itemize} - \item {start with the broadest (or most general) topic and lead towards the narrowest (or most specific)} + \item {i.e. start with the broadest (most general) and lead towards the narrowest (most specific)} \end{itemize} } \item {think carefully and critically about the groupings of literature} @@ -52,17 +56,33 @@ \section*{Guidelines for this Chapter}\label{sec:lit_rev_guidelines} \section{Introduction}\label{sec:lit_intro} \begin{itemize} - \item {Provide a brief statement outlining what the chapter is about and how it will be structured} + \item {Provide a brief statement outlining: + \begin{itemize} + \item {what the chapter is about?} + \item {how will the chapter be structured?} + \end{itemize} + } \end{itemize} % FILLER CONTENT % You should be splitting your literature into themeatic sections. \section{Topic 1}\label{sec:lit_topic1} -\lipsum[1] +\begin{itemize} + \item {Provide a discussion about your first topic/theme + \begin{itemize} + \item {i.e. History of Penetration Testing} + \end{itemize} + } +\end{itemize} -% FILLER CONTENT -\section{Topic 2}\label{sec:lit_topic2} -\lipsum[1] +\subsection{Sub-Topic i}\label{sec:lit_topic1_subtopici} +\begin{itemize} + \item {Sub-topics for each topic/theme can also be presented and discussed + \begin{itemize} + \item {i.e. Personal Computers and Servers, Mobile Devices} + \end{itemize} + } +\end{itemize} \section{Conclusion}\label{sec:lit_con} \begin{itemize} diff --git a/chapters/3_Methodology.tex b/chapters/3_Methodology.tex index ae0ca3c..6c62030 100644 --- a/chapters/3_Methodology.tex +++ b/chapters/3_Methodology.tex @@ -1,5 +1,22 @@ \chapter{Methodology}\label{ch:methodology} +\section*{Guidelines for this Chapter}\label{sec:meth_guidelines} +\textbf{\color{red}{This is not a section in your report, but will give you some tips and guidance on what you should be +including in your methodology.}} + +\begin{itemize} + \item {Provide an outline of the research process that has been undertaken + \begin{itemize} + \item {this will range from selecting the method to discussing about the tool or approach used for analysing + data} + \end{itemize} + } + \item {Structure your chapter in a linear fashion + \begin{itemize} + \item {discuss how certain decisions have impacted any subsequent choices} + \end{itemize} + } +\end{itemize} \section{Introduction}\label{sec:meth_intro} \begin{itemize} @@ -11,7 +28,12 @@ \section{Introduction}\label{sec:meth_intro} \ldots} \end{itemize} } - \item {Provide a brief statement outlining what the chapter is about and how it will be structured} + \item {Provide a brief statement outlining: + \begin{itemize} + \item {what the chapter is about?} + \item {how will the chapter be structured?} + \end{itemize} + } \end{itemize} diff --git a/chapters/4_Results_Analysis.tex b/chapters/4_Results_Analysis.tex index 9fa3c2e..cfd471e 100644 --- a/chapters/4_Results_Analysis.tex +++ b/chapters/4_Results_Analysis.tex @@ -1,8 +1,10 @@ \chapter{Results and Analysis}\label{ch:results-and-analysis} \section*{Guidelines for this Chapter}\label{sec:res_anal_guidelines} +\textbf{\color{red}{This is not a section in your report, but will give you some tips and guidance on what you should be +including in your results and analysis.}} \begin{itemize} - \item {Provide a direct and factual account of the data collection + \item {Provide a direct and factual account of the data you have collected \begin{itemize} \item {there should be no interpretation of the findings} \end{itemize} @@ -33,9 +35,27 @@ \section*{Guidelines for this Chapter}\label{sec:res_anal_guidelines} } \end{itemize} } + \item {Do not over-rely on tables and figures + \begin{itemize} + \item {tables and figures does not replace your written account of the data} + \item {do not supply detail on every point in the data, provide some discussion on what the data shows + \begin{itemize} + \item {draw the reader to the most important elements of the data} + \end{itemize} + } + \end{itemize} + } + \item {Do not present raw/unprocessed data + \begin{itemize} + \item {this will obscure the clarity of your research} + \item {raw data can be provded in the appendix} + \end{itemize} + } \end{itemize} +\newpage \section*{Example of a Table in LaTeX}\label{sec:table_example} +\textbf{\color{red}{This is an example of how a table would be created in LaTeX.}} \begin{table}[ht] \caption{The number of people who like a given fruit.} \newlength\q @@ -43,7 +63,7 @@ \section*{Example of a Table in LaTeX}\label{sec:table_example} \renewcommand{\arraystretch}{1.5} \begin{tabular}{|p{\q}|p{\q}|} \hline - Fruit & \# of People \\ \hline + \textbf{Fruit} & \textbf{\# of People} \\ \hline Apple & 1 \\ \hline Blueberry & 2 \\ \hline Cantaloupe & 3 \\ \hline @@ -53,6 +73,36 @@ \section*{Example of a Table in LaTeX}\label{sec:table_example} \section{Introduction}\label{ch:results_anal_intro} \begin{itemize} - \item {Provide a brief statement outlining what the chapter is about and how it will be structured} + \item {Provide a brief statement outlining: + \begin{itemize} + \item {what the chapter is about?} + \item {how will the chapter be structured?} + \end{itemize} + } \end{itemize} +% FILLER CONTENT +% You should be splitting your literature into themeatic sections. +\section{Results/Dataset 1}\label{sec:resanal_resdata1} +\begin{itemize} + \item {Present your first set of results + \begin{itemize} + \item {provide some analysis on the data, but do not discuss them!} + \end{itemize} + } +\end{itemize} + +\section{Results/Dataset 2}\label{sec:resanal_resdata2} +\begin{itemize} + \item {Present your second set of results + \begin{itemize} + \item {provide some analysis on the data, but do not discuss them!} + \end{itemize} + } +\end{itemize} + +\section{Conclusion}\label{sec:resanal_conc} +\begin{itemize} + \item {Provide a \textbf{brief} summary on the key findings from your data} + \item {Highlight the most relevant findings for your research questions} +\end{itemize} \ No newline at end of file diff --git a/chapters/5_Discussion.tex b/chapters/5_Discussion.tex index d6c0396..5c14cdb 100644 --- a/chapters/5_Discussion.tex +++ b/chapters/5_Discussion.tex @@ -1,6 +1,8 @@ \chapter{Discussion}\label{ch:discussion} \section*{Guidelines for this Chapter}\label{sec:disc_guidelines} +\textbf{\color{red}{This is not a section in your report, but will give you some tips and guidance on what you should be +including in your discussion.}} \begin{itemize} \item {Similar to the literature review, split your discussion into themes (known as a thematic structre) \begin{itemize} @@ -27,7 +29,9 @@ \section*{Guidelines for this Chapter}\label{sec:disc_guidelines} } \end{itemize} +\newpage \section*{Example of a Figure in LaTeX}\label{sec:figure_example} +\textbf{\color{red}{This is an example of how a figure would be created in LaTeX.}} \begin{figure}[ht!] \includegraphics[width=\textwidth]{images/sample_graph} \caption{A graph showing the data from Table~\ref{tab:sample_table}.} @@ -36,7 +40,31 @@ \section*{Example of a Figure in LaTeX}\label{sec:figure_example} \section{Introduction}\label{sec:disc_intro} \begin{itemize} - \item {Provide a brief statement outlining what the chapter is about and how it will be structured} + \item {Provide a brief statement outlining: + \begin{itemize} + \item {what the chapter is about?} + \item {how will the chapter be structured?} + \end{itemize} + }\end{itemize} + +% FILLER CONTENT +% You should be splitting your literature into themeatic sections. +\section{Discussion on RQ1}\label{sec:discussion-rq1} +\begin{itemize} + \item {Present your discussion on how you answered your research question + \begin{itemize} + \item {relate back to the literature you have reviewed + \begin{itemize} + \item{this will contextualise and depend the readers understanding on your findings} + \end{itemize} + } + \end{itemize} + } +\end{itemize} + +\subsection{Limitations}\label{sec:discussion-rq1-limitations} +\begin{itemize} + \item {Provide a discussion on any limitations with your results/discussion} \end{itemize} \section{Conclusion}\label{sec:disc_conc} diff --git a/chapters/6_ProjectManagement.tex b/chapters/6_ProjectManagement.tex index 2736998..31e04d2 100644 --- a/chapters/6_ProjectManagement.tex +++ b/chapters/6_ProjectManagement.tex @@ -1,6 +1,68 @@ \chapter{Project Management}\label{ch:project-management} -\lipsum[2-5] -\section{Legal, Ethical and Social Constraints}\label{sec:legal-ethical-and-social-constraints} -\lipsum[2-5] -\section{Student Reflection}\label{sec:student-reflection} -\lipsum[2-5] \ No newline at end of file + +\section*{Guidelines for this Chapter}\label{sec:project-management-guidelines} +\textbf{\color{red}{This is not a section in your report, but will give you some tips and guidance on what you should be +including in your project management.}} +\begin{itemize} + \item {\color{blue}{\textbf{You are permitted to write in first person for this chapter}}} + \item {Discuss how your project has evolved + \begin{itemize} + \item {link back to the Gantt chart from your proposal and present a new (actual) timeline of events} + \end{itemize} + } + \item {Did you have any problems? Discuss how these impacted your study and how they were resolved} + \item {Discuss any legal, ethical and social constraints you may have faced + \begin{itemize} + \item {you could discuss the following: + \begin{itemize} + \item {personal bias} + \item {uncontrollable societal variables} + \item {difficulty of the topic that could be ethically challenged, offensive or derogatory} + \end{itemize} + } + \end{itemize} + } +\end{itemize} + +\section{Introduction}\label{sec:project-management-introduction} +\begin{itemize} + \item {Present your discussion on how you answered your research question + \begin{itemize} + \item {relate back to the literature you have reviewed + \begin{itemize} + \item{this will contextualise and depend the readers understanding on your findings} + \end{itemize} + } + \end{itemize} + } +\end{itemize} + +\section{Legal, Ethical and Social Constraints}\label{sec:project-management-legal-ethical-and-social-constraints} +\begin{itemize} + \item {Discuss any legal, ethical and social constraints you may have faced + \begin{itemize} + \item {you could discuss the following: + \begin{itemize} + \item {personal bias} + \item {uncontrollable societal variables} + \item {difficulty of the topic that could be ethically challenged, offensive or derogatory} + \end{itemize} + } + \end{itemize} + } +\end{itemize} + +\section{Student Reflection}\label{sec:project-management-student-reflection} +\begin{itemize} + \item {Provide a reflection of your project + \begin{itemize} + \item {how were your supervisory meetings?} + \item {did you have any issues with the project? how did you resolve them or get around them?} + \end{itemize} + } + \item {Reflect on your timeline of development + \begin{itemize} + \item {provide the Gantt chart from your proposal and the new \textbf{updated} Gantt chart} + \end{itemize} + } +\end{itemize} \ No newline at end of file diff --git a/chapters/7_Conclusion.tex b/chapters/7_Conclusion.tex index 5e47574..b0ba2d1 100644 --- a/chapters/7_Conclusion.tex +++ b/chapters/7_Conclusion.tex @@ -1,6 +1,8 @@ \chapter{Conclusion}\label{ch:conclusion} \section*{Guidelines for this Chapter}\label{sec:conc_guidelines} +\textbf{\color{red}{This is not a section in your report, but will give you some tips and guidance on what you should be +including in your conclusion.}} \begin{itemize} \item {Do not repeat the main findings of your research} \item {Provide a summary and synthesis of your main findings and points of discussion} @@ -19,7 +21,15 @@ \section*{Guidelines for this Chapter}\label{sec:conc_guidelines} \section{Introduction}\label{sec:conc_intro} \begin{itemize} \item {Recap the research problem/gap in the research} - \item {Provide a brief statement outlining what the chapter is about and how it will be structured} + \item {Present your discussion on how you answered your research question + \begin{itemize} + \item {relate back to the literature you have reviewed + \begin{itemize} + \item{this will contextualise and depend the readers understanding on your findings} + \end{itemize} + } + \end{itemize} + } \end{itemize} \section{Future Work} \label{sec:conc_future} diff --git a/out/6047cem_report_template.pdf b/out/6047cem_report_template.pdf index b057400..a9c64b2 100644 Binary files a/out/6047cem_report_template.pdf and b/out/6047cem_report_template.pdf differ