A project report in LaTeX is a text file that starts with a \documentclass line, loads packages in the preamble, and puts the content between \begin{document} and \end{document}. Create the file, paste in the minimal example below, and compile it. Then replace the text with your own. This guide explains the choices in that example and the parts most reports need.
Pick a document class: article or report
articlesuits a short report of a few pages with sections but no chapters.reportsuits a longer report that needs chapters, and it adds the chapter numbering and separate pages for the contents and lists.
If your course gives a template, use it. Without one, report is a reasonable default for a longer project. For a thesis-length document, the thesis guide covers the book class and its front-matter commands.
A minimal project report
Save this as report.tex. It uses only standard packages.
\documentclass[12pt,a4paper]{report}
\usepackage[margin=2.5cm]{geometry}
\usepackage{graphicx}
\usepackage{booktabs}
\usepackage[hidelinks]{hyperref}
\title{Project Report Title}
\author{Jane Doe}
\date{\today}
\begin{document}
\maketitle
\tableofcontents
\listoffigures
\listoftables
\chapter{Introduction}
This chapter introduces the problem and the aims of the project.
The method is described in Chapter~\ref{ch:method}.
\chapter{Method}\label{ch:method}
This chapter explains how the work was carried out.
\begin{table}[htbp]
\centering
\caption{Settings used in the tests.}
\label{tab:settings}
\begin{tabular}{lc}
\toprule
Parameter & Value \\
\midrule
Repetitions & 5 \\
Sample size & 30 \\
\bottomrule
\end{tabular}
\end{table}
\begin{figure}[htbp]
\centering
\includegraphics[width=0.7\textwidth]{figure1.pdf}
\caption{Result of the main test.}
\label{fig:result}
\end{figure}
Figure~\ref{fig:result} shows the main result, and Table~\ref{tab:settings} lists the settings.
\chapter{Conclusion}
This chapter summarizes what was done and what could come next.
\bibliographystyle{plain}
\bibliography{references}
\end{document}
Put references.bib and a file named figure1.pdf in the same folder. If you do not have a figure yet, delete the figure block, because LaTeX stops with an error when an image file is missing. On Overleaf, upload both files to the project before compiling.
Compile with pdflatex report.tex and run it a second time so the contents, lists and references update. Running latexmk -pdf report.tex does the repeats for you.
Sections a project report usually needs
Most courses expect some version of the following, in roughly this order:
- A title page with the course, module code, student name and date.
- An abstract or summary.
- A table of contents, and lists of figures and tables if the report is long.
- An introduction that states the aims and scope.
- Background or a review of related work.
- The method or design.
- The results.
- A discussion of what the results mean and their limits.
- A conclusion and, if asked for, future work.
- References and any appendices.
The marking scheme sets the real requirements. Some courses fix the headings, the length or the order, and those rules override this list.
Title page and front matter
\maketitle prints the title, author and date. Many courses want more on the title page, such as a module code, a logo or an instructor name. For that, use a titlepage environment as shown in the thesis guide, which gives full control over the layout.
Figures and tables
Every figure and table needs a \caption and a \label. The caption describes what the reader sees, and the label lets you refer to it with \ref. Put table captions above the table and figure captions below the figure, which is the common convention in reports. Use booktabs rules (\toprule, \midrule and \bottomrule) for clean tables.
Refer to each figure and table in the text. A figure that nothing mentions is easy for a marker to overlook.
Code listings: listings or minted
Code is common in project reports, and there are two popular packages for it.
-
listingsneeds no extra tools and works with a plainpdflatexrun:\usepackage{listings} % in the document \begin{lstlisting}[language=Python] def mean(values): return sum(values) / len(values) \end{lstlisting} -
mintedgives richer syntax highlighting, but it runs an external program (Pygments). Overleaf supports it. On a local machine, add-shell-escapeto the compile command, for examplelatexmk -pdf -shell-escape report.tex.
For a first report, listings is the simpler choice.
References
Use BibTeX the way the thesis guide describes, or see bibliographies and citations in LaTeX for the full workflow. Keep every entry in references.bib and cite it with \cite{key}. Many courses ask for a specific style. For IEEE-style numbered references, use \bibliographystyle{IEEEtran} with the IEEE bibliography style that ships with TeX distributions. For other styles, your course will name the one to use.
Is LaTeX difficult to learn?
LaTeX has a learning curve. Most of it sits in packages, in the error messages, and in the difference between an error that stops the compile and a warning that does not. A template removes much of that work, and most people can produce a working report after a few sessions. Reading the first error line in the log, and fixing one problem at a time, helps more than memorizing commands. For a longer answer, see is LaTeX difficult to learn?.
For a comparison with Word, see is LaTeX better than MS Word?.
Can ChatGPT write a LaTeX report?
AI tools can draft LaTeX code for a report, and they often produce a working skeleton. Check the result before you rely on it:
- Compile it, and read the log for errors.
- Check every citation. Language models can invent references that look real.
- Check every figure path and label.
- Check your course’s policy on AI use, because the report is expected to be your own work.
Final checklist
- The document compiles with no errors, and the log has no warnings you have not understood.
- Every figure and table has a caption and a label, and the text refers to each one.
- Every reference is real, appears in
references.bib, and uses the required style. - The contents and lists are up to date after a second compile.
- The page size, margins and headings match the brief.
If the report is shared with a tutor who wants Word, the Pandoc guide explains how to make a Word copy. If the report grows into a paper, the research paper guide shows the standard structure.