Typical Mistakes You Should Avoid When Writing Your Thesis

Contents

By Joshua Meyer and Timo P. Gros

A bachelor’s/master’s thesis is often (one of) the first scientific work(s) that a student writes. Therefore, it is not unusual to encounter the same, common mistakes when proofreading or grading theses. In this non-exhaustive guide, we want to draw attention to some of the typical mistakes and how to best avoid them. To this end, we list a general rule to follow, and provide good and bad examples. Please follow the good examples rather than the bad ones. Also note that there are, as always, cases in which a rule can be broken, e.g., to provide emphasis.

Adhering to the rules stated on this page will save us time and nerves, and help you get better feedback that is more specific to your particular thesis. For more information, see also the organizational notes for writing your thesis with us.

Equations

Embedding

Rule

Embed equations in the text.

Avoid introducing them with a colon, but don’t leave them floating without any connection either.

Good

In the following, let $$ G_t = \sum_{k=t+1}^{T} \gamma^{k-t-1} R_k \tag{1} $$ denote the discounted, accumulated reward, also called return, from time $t$ on, where $\gamma \in [0, 1]$ is the discount factor, and $T$ is the final time step.

Bad: Colon

Let $G_t$ denote the discounted, accumulated reward, also called return, from time $t$ on, where $\gamma \in [0, 1]$ is the discount factor, and $T$ is the final time step: $$ G_t = \sum_{k=t+1}^{T} \gamma^{k-t-1} R_k \tag{2} $$

Bad: Floating

Let $G_t$ denote the discounted, accumulated reward, also called return, from time $t$ on, where $\gamma \in [0, 1]$ is the discount factor, and $T$ is the final time step. $$ G_t = \sum_{k=t+1}^{T} \gamma^{k-t-1} R_k \tag{3} $$

Punctuation

Rule

Use correct punctuation.

Your formula is part of the sentence! This means you must use correct punctuation. If the sentence ends with your formula, end with a full stop; if you need to set a comma grammatically, type a comma.

Good

The discounted, accumulated reward, also called return, from time $t$ on, is given by $$ G_t = \sum_{k=t+1}^{T} \gamma^{k-t-1} R_k, \tag{4} $$ where $\gamma \in [0, 1]$ is the discount factor, and $T$ is the final time step.

Assuming $\gamma$ and $T$ have already been introduced:

Good

We define the discounted, accumulated reward, also called return, from time $t$ on, as $$ G_t = \sum_{k=t+1}^{T} \gamma^{k-t-1} R_k. \tag{5} $$

Citations

Usage as Nouns (or Words)

Rule

A citation is not a word.

Do not use it in a sentence as if it were one.

$\LaTeX$ provides some useful commands for this. Import natbib via \usepackage{natbib} and use

  • \citep for paranthesized citations (Good 1)
  • \citet for in-text citations (Good 2)

If you prefer writing \cite (e.g., due to muscle memory), you can use \let\cite\citep.

Good (paranthesized)

… the state value function [4].

generated by: \dots the state value function~\citep{citation-key}

Good (in-text)

… as introduced by Sutton and Barto [4].

generated by: \dots as introduced by Sutton and Barto~\citet{citation-key}.

Bad: Use as a noun

… the state value function as introduced in [4].
[4] defines the state value function …

Non-breaking Spaces

Rule

Use text~\citep{sutton2018reinforcement}.

No space, as in text\citep{sutton2018reinforcement}, or
a breaking space, as in text \citep{sutton2018reinforcement} can create badly formatted text.

Good

text [4]

generated by: text~\citep{citation-key}

Bad: no space

text[4]

generated by: text\citep{citation-key}

Bad

many, many, and a few more words that should cause a line break
[4]

generated by: many, many, and a few more words that should cause a line break \citep{citation-key}

Another example (assuming \rt is a defined command for the word ‘Racetrack’), where space vanishes. Through correct macro definition, e.g., via xspace, this case can be circumvented though.

Bad: macro expansion

Racetrack[4]

generated by: \newcommand{\rt}{Racetrack} ... \rt \citep{citation-key}

Capitalization

Within a Sentence

Rule

Do not use captilization as a means to emphasize words.

More elaborately: do not capitalize words just because they seem important, well-known, or are part of a defined construct.

Good

Markov

Markov decision process (MDP)

Students tend to use capital letters for important words or constructs, e.g.,

Bad

Markov Decision Process

instead of “Markov decision process”. In general, this is incorrect. If you want to emphasize the importance of an expression, rather use \emph{…} (or a similar notion) when the word occurs for the first time, and write it normally afterward.

Good

… define a Markov decision process. … A great example for a Markov decision process is …

After Colons

A colon is used to introduce something that is strongly related, such as a list of particulars, an amplification, or a conclusion. The style guides agree that, therefore, one should generally use the lowercase letter after the colon. Exceptions are names, etc., that would also be spelled with a capital letter mid-sentence.

Some style guides propose to use a capital letter after a colon when what follows is a complete sentence. However, this makes it more difficult to decide when to use lower- or uppercase. Thus, the simpler rule is to simply stick to lowercase:

Rule

Use lowercase after a colon.

The only exceptions words that would be spelled capitalized mid-sentence as well.

Good

… how the agent performs in unknown situations: if it was able to generalize …
… three languages: English, German, and French.

Bad

… how the agent performs in unknown situations: If it was able to generalize …
… three languages: english, german, and french.

In Headings

Depending on the publisher, different title and heading capitalizations are used. Generally,

  • the first letter is capitalized, and
  • all “proper” words are capitalized (for some definition of proper).

The style guides differ when it comes to, e.g., adverbs, conjunctions, prepositions, hyphenated words, … When writing your thesis, the most important thing is: decide for one and stay consistent.

Rule

Decide for one guideline and stay consistent.

If in doubt, there are pages to help you out, e.g.,

Good: Section/Chapter Headings
  • Related Work
  • Empirical Evaluation
  • Conclusion and Future Work
  • Procedurally Generated Grid-Based Traffic Gym
  • The Importance of Verifying Neural Agents
  • Current State of the Art of Reporting Agents’ Performances
  • Analyzing Neural Agents Using PyDSMC
Bad: Section/Chapter Headings
  • related work
  • Analyzing neural Agents using PyDSMC

Inconsistent styles:

  • Procedurally Generated Grid-Based Traffic Gym
  • Procedurally Generated Grid-based Traffic Gym

For the thesis title, you have slightly more freedom, e.g., if you want to emphasize an acronym:

Good: Thesis Title

MARS: Multi-sample Allocation through Russian roulette and Splitting

Figures

Reference

Rule

Never display figures without referring to them.

Figures that you do not use within your text are a waste of space. Without a reference, a reader will not know when the figure is relevant or what it is supposed to show. Exactly describe what you want the reader to see/to learn from the figure. Do not babble unnecessarily about the figure, but in every case refer to it. Sometimes it is even enough to just put it in parantheses at the end of a sentence.

Good

Consider Figure 1, which depicts a screenshot of the website. You only need to enter your heading and press Convert to receive the heading in its correct form.

Bad

See section 6.

Figure 1 is without mention, without usage.

Captions

PDFs

How to Use Latin Abbreviations

Some Latin abbreviations are commonly used in our field. However, they are often misused in students’ theses. Therefore, we here examine their correct usage.

AbbreviationLatinMeaning
et al.et alii, et alia, et alibiand others
etc.et ceteraand the others, and other things, and the rest
e.g.exempli gratiafor example, for instance
i.e.id estthat is, in other words
Rule

When a sentence ends with an abbreviation, do not set a double period, but use all other punctuation marks.

A bad example would be

Bad

… they had apples, oranges, etc.. Also, …

while it is correct to write

Good

… they had apples, oranges, etc.! Also, …

Rule

Both e.g. and i.e. are conjunctive adverbs. Do not use them at the beginning of a sentence.

Conjunctive adverbs connect two sentences. Other examples are ‘however’, ’thus’, or ’though’. The correct usage therefore is

Good

… they had a lot of fruit, e.g., apples, oranges, and bananas.
… the return, i.e., $G_t = \sum_{k=t+1}^{T} \gamma^{k-t-1} R_k$.

While it is common to use other conjunctive adverbs in the beginning of a sentence, e.g.,

Good

However, …

it would not make any sense to do this with ’e.g.’ or ‘i.e.’:

Bad

… they had a lot of fruit. E.g., apples, oranges, and bananas …

Note that you cannot use ’etc.’ in combination with ’e.g.’ or with similar terms such as ‘such as’ or ‘for example’.

Usually, publisher guidelines define when all author names should be spelled out and when you should use ’et al.’ within the text (in the bibliography, usually all authors are listed). For your thesis, I suggest the following (which is also common for most publishers): spell out the name of one or two author(s), and use ’et al.’ for three or more authors, e.g.,

Good
AuthorSpelling
Jane DoeDoe
Jane Doe, Max MustermannDoe and Mustermann
Jane Doe, Max Mustermann, Jean Tout-le-mondeDoe et al.
Jane Doe, Max Mustermann, …, Jean Tout-le-mondeDoe et al.

Introduce Abbreviations

Rule

Introduce abbreviations for the most important concepts and use them regularly. Never use an abbreviation that was not introduced.

Abbreviations make your text easier to read and understand. Let’s revisit a former example that gets even better when instead writing:

Good

… define a Markov decision process (MDP). … A great example for an MDP is …

If you are using common constructs, e.g., Markov decision processes, make sure to use the common abbreviations (here MDP) and do not invent new ones. Only introduce new abbreviations if there are no commonly used ones in the literature. Still, do not use an abbreviation that you did not introduce, regardless of how common and well-known it is.

Define Your Commands

One of the worst things about a thesis is inconsistency. This is not just a question of style, e.g., whether to write racetrack or Racetrack, but can further lead to the reviewers misunderstanding your thesis, e.g., if an important aspect is referred to by two different names and the reader is not aware that those names mean the same. An easy mechanism to avoid such ambiguities is to define LaTeX commands for every important or regularly used expression.

Rule

Generously make use of \newcommand{}{}. Define commands for every word/expression/… you use regularly.

Not only does this decrease the chances of inconsistencies, but it also makes changes that might be required mid-writing much easier.

Variable Names in Math Mode

Rule

When using variables that are longer than a single letter, use \mathit{}.

In math mode, LaTeX assumes every letter to be its own variable. If we assume your variable to be named “TEST”, simply writing $TEST \cdot TEST$ results in this ugly version

Bad

$TEST \cdot TEST$

while when using mathit, the letters are displayed closer together, i.e., $\mathit{TEST} \cdot \mathit{TEST}$ produces

Good

$\mathit{TEST} \cdot \mathit{TEST}$

Consistency

Minor decisions in your thesis, e.g., whether to write figure with a lowercase or Figure with an uppercase letter when referring to a figure, are not incredibly important. However, (as already mentioned,) one of the worst things about a thesis is inconsistency. When you make a minor decision for a “style”, stick to that decision throughout your thesis.

Rule

For each decision you make: stay consistent.

Use Spell and Grammar Checkers

Even though the quality of your language does not explicitly influence the grade of your thesis, it implicitly does. First, it can be quite hard to understand what you want to express if the thesis is not written in proper English. Second, it is hard to focus on the content of your thesis when there are many language errors.

Rule

Whenever you send (a part of) your thesis to your supervisor or advisor, make sure that there are neither typos nor grammar issues.


Note

So far, this guide lists very concrete mistakes and shows how to fix them. It should be easy to avoid these mistakes after reading it. The following sections do not describe concrete mistakes but rather give general advice for writing. You will probably need practice to follow them. However, as I still find that it is helpful information, the following special sections rightfully belong here.

Whether to Use Active or Passive Voice; Whether to Use the First Person Pronoun

This section will be shorter than it should be; I could write a whole book (or at least a paper) about it. I here summarize my point of view on this complicated matter. Note that whatever this summary states holds only in our area of science – if at all.

Active Versus Passive Voice

Ancient science tells us to favor the passive voice over the active one. However, this is no longer true – and it has not been for quite some time. Sadly, this knowledge has not reached (all) schools yet, where the passive voice is still taught to be favorable.

Rule

Whenever possible, prefer the active voice over the passive one.

Most of the style guides of journals, experts, … agree that the active voice is not only shorter but makes a sentence more readable. However, while you should use the passive voice carefully, it is not strictly forbidden to use it. Try to keep its usage to a minimum. Compare the active sentence

Good

… this summary lists typical mistakes you should avoid

with the passive one

Bad

… in this summary typical mistakes you should avoid are listed

The active voice is not only 20% (2 words out of 10) shorter, but also easier to read. There are many examples (you can easily find references on the web) where the saving is even significantly higher.

Whether to Use the First Person Pronoun

Once again, you might be surprised: the vast majority of journals, experts, … agree that there are no restrictions on using the first person pronoun. This includes both the singular (‘I’) and the plural (‘we’) forms, depending on whether you are a single author or a group of authors, respectively. (As you are writing your thesis, of course, you are a single author.) However, in our field, it is uncommon to use ‘I’. Therefore we conclude:

Rule

Make use of the first person pronoun. Stick to the plural form (‘we’).

There are several examples to justify this rule. We here only want to look at a common phrase

Good

We conducted an experiment …

which informs the reader not only about the experiment but that we did it. In comparison, the passive voice

Bad

An experiment was conducted …

clearly does not answer who conducted the experiment. Science should be as precise as possible. There is no reason to conceal who conducted the experiment.

Whether to Use the First Person Pronoun and the Active Voice Together

When looking at the last example, the answer is clearly yes: we were the ones to conduct the experiment, we want to share that information and, therefore, ‘we’ needs to be the subject of the sentence. Still, let’s revisit another example:

Bad

… we summarized typical mistakes you should avoid

Is the information that we created the summary necessary to the sentence? The list of the author(s) is at the top of the page anyway, and for the concrete sentence, the information is not important at all. It is better to make the ‘summary’ the subject:

Good

… this summary lists typical mistakes you should avoid

In conclusion:

Rule

Use the first person pronouns whenever necessary, but try to avoid them otherwise.

Editorial We

The ’editorial we’ means the inclusion of a further group of people in addition to the author(s), e.g., the author(s) and the reader together, a larger group of scientists (including the author), even all scientists in general, etc. – and exactly this ambiguity constitutes a problem. Remember, science should be as precise as possible; the ambiguity introduced by the ’editorial we’ represents the opposite. However, consider this example:

Good

… in Chapter 5, we examine …

Clearly, ‘we’ here is editorial: it means the author(s) and the reader. This sentence is hard to write otherwise – at least when sticking to the active voice. Therefore, our rule comes as a compromise:

Rule

Do not overuse the ’editorial we’. Use it only to express ’the author(s) and the reader’, but never to write about other, equivocal groupings.

The difference between ‘we’ representing only the author(s), and ‘we’ representing author(s) and reader together can be distinguished by the context of the sentence.

Tenses

There are several different guides that, in a very complicated and very detailed manner, explain which tense to use depending on the chapter and even on the type of content. Mostly, they do not agree with each other. This section describes the solution I have found for myself. I claim neither that this solution is perfect nor that it is the only way to do it – I merely describe a rough guideline which might be helpful.

Present Tense

The present tense is the main tense of your thesis. Use it when writing about your work, e.g., describing figures, presenting results, analyzing your findings, discussing your results, etc. A few examples are:

Good

As Figure 5 displays …
We conclude that …
… this leads to the conclusion …

Also, the present tense is used to describe things that are generally accepted in your field, or to refer to findings from other papers (both with a reference), e.g.,

Good

… DQN is more stable than NFQ [2] …
… Gros et al. claim that the learning curve is not meaningful enough and, therefore, DSMC should be used [1].

Past Tense

Use the past tense when writing about experiments you conducted before writing your thesis, e.g.,

Good

… we trained different agents …
we conducted specific experiments that …

Note that these things you describe in the past tense must be finished before you can write your thesis – in contrast to the analysis, results, etc., you describe in the present.

Also use the past tense when writing about methodology published in former publications, e.g.,

Good

… Deep Q-learning, introduced by Mnih et al. [2], …
… as we examined in prior work [1], …

or when writing about things that were disproved, e.g.,

Good

… the world was thought to be flat …

Lastly, use the past tense when summarizing things you already wrote earlier (which usually is the case in the conclusion), e.g.,

Good

With this paper, we presented a long list of mistakes to avoid …
… we showed how the approach works by …

Future Tense

Use the future tense only when writing about things not included in the paper but left open (which usually is the case in future work), e.g.,

Good

In the future, we will address the problem …
We will continue developing …

Putting It All Together

It is hard to summarize all of this into a simple rule, but I think it comes down to this:

Rule

Generally use the present tense, except for describing things in the past (use the past tense) or things that will happen in the future (use the future tense).

There is no need for overly complex tense rules.

Being Concise

Again, this section will be shorter than it should be. There are courses and papers just about how to be concise in science. One of the oldest and best known books about English writing describes writing concisely as: “A sentence should contain no unnecessary words, a paragraph no unnecessary sentences, for the same reason that a drawing should have no unnecessary lines and a machine no unnecessary parts. This requires not that the writer make all sentences short or avoid all detail and treat subjects only in outline, but that every word tell.” [3] At the same time, the same book advises: “Do not take shortcuts at the cost of clarity.” [3] Our ruling joins the two pieces of advice of Strunk and White:

Rule

Try to express yourself as briefly and as precisely as possible, but write in enough detail for readers to understand your writing.

Note that this guide is an explanation and not a publication. In many parts, it is not concise, e.g., repeating some things, or using more words than needed to ensure clarity in a way you would not use in a publication.


Closing note: Please note that having this list of typical mistakes to avoid does not mean that I did not make (some) of these mistakes in the past or that I will never make them again in the future. However, both you and I should try to stick to these rules.

References

  1. Gros, T.P., Hermanns, H., Hoffmann, J., Klauck, M., Steinmetz, M.: Deep Statistical Model Checking. In: Proceedings of the 40th International Conference on Formal Techniques for Distributed Objects, Components, and Systems (FORTE'20) (2020), available at https://doi.org/10.1007/978-3-030-50086-3_6
  2. Mnih, V., Kavukcuoglu, K., Silver, D., Rusu, A.A., Veness, J., Bellemare, M.G., Graves, A., Riedmiller, M., Fidjeland, A.K., Ostrovski, G., et al.: Human-level control through deep reinforcement learning. Nature 518(7540), 529–533 (2015)
  3. Strunk Jr, W., White, E.B.: The Elements of Style Illustrated. Penguin (2007)
  4. Sutton, R.S., Barto, A.G.: Reinforcement learning: An introduction. MIT press (2018)