Final Year Project Report Best Practices

Chapter 9 · Practice 2 of 3

If you write in LaTeX or Markdown, keep the report in Git

From Version control and backups for the report

Why it matters

Teams already using Git for code can manage the report the same way. Split it so people rarely edit the same file:

text
report/
  main.tex
  chapters/01-introduction.tex
  chapters/02-literature-review.tex
  chapters/03-design.tex
  figures/            (diagram sources and exports)
  references.bib

Commit small, meaningful changes with clear messages ("Add sync conflict results to chapter 5"), and tag the versions you submit for each evaluation, such as mid-evaluation and final-submission. Tags let you show exactly what was submitted when, and compare it with the current draft.

Do

  • One file per chapter to avoid conflicts
  • Tag the version submitted at each evaluation

Avoid

  • One huge file the whole team edits at once