softvare-group / thesistemplate

A template for bachelor, master, or PhD theses based on a template by Roland Bless and on a template by Martin Kuhlemann. The template is available for theses in English and in German. Bugs and recommendations are welcome.

Thesis Template

A template for bachelor, master, or PhD theses written in LaTeX. The template is available for theses in English and in German.

Bugs and recommendations are welcome: https://github.com/SoftVarE-Group/ThesisTemplate/issues/new/choose

The template is based on a template by Roland Bless and on another template by Martin Kuhlemann.

thesistemplate's Issues

Common mistakes in writing

DONTs

• i.e. and e.g. not in brackets
• unclear reference: this, the line, the step, ...
• no topic sentences (incl. paragraph too short, missing coherence in paragraph)
• use of could, would if unnecessary
• too many brackets, brackets used for two meanings
• getting more detailed with every paragraph and closing a section/chapter without a summary
• complicated sentences
• synonyms
• unknown abbreviations
• duplication of information that is not made explicit (e.g., a repetition without referring to the fact that it is a repetition)
• reflexive use of verb "allow" (allow whom?) - similar words: contradict
• monotone sentence structure
• plural leading to misunderstanding (use singular instead)
• out of the blue: missing introductions/motivations of terms/concepts
• typesetting: bold font in paragraphs for emphasis (use \emph)
• style: use of references as parts (object/subject) in sentences (e.g., "as shown in [1]")
• overly complex word combinations: 4+ words
• wrong position of the words also/only/... -> changing the meaning
• inconsistent capitalization in titles (2 potential options)
• prefix, sentence (often the comma is missing)
• refering to subsection and subsubsection, unresolved overfull boxes (too LaTeX)
• line with single word or single line on next page (Schusterjungen und Hurensöhne)
• line of though (roter Faden)
• inconsistent tense
• use of "if" when "whether" is appropriate

DOs

• use as verb (simplifies understanding) and in next sentences as noun (simplication helps)
• use variables only prefixed by natural language term (e.g., feature f)
• use numbers with units whenever feasible to avoid confusion (e.g., 3 of 5 participants)
• reorder parts of each sentence such that they are easier to follow
• every claim needs (a) a reference, (b) an argumentation, (c) empirical evidence, (d) other evidence such as proofs

Active voice

A very common mistake, especially for Germans is to use only passive voice. Write a recommendation into the example chapter on this topic.