Skip to content

Commit

Permalink
grammar correction with grammarly on overleaf
Browse files Browse the repository at this point in the history
  • Loading branch information
homberghp committed May 21, 2024
1 parent e993fbb commit af8d7a3
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 20 deletions.
40 changes: 20 additions & 20 deletions chapters/ch01_intro.tex
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ \chapter{Introduction}
Writing documentation is often considered a chore. But actually reading student reports is even worse.
Certainly if the student is to wordy, sloppy, repeats every other section and so on.

The Casus Belli in this case is that I have been examiner of a lot,
The Casus Belli, in this case, is that I have been an examiner of a lot,
not to say most students in the informatics courses at Fontys
Hogeschool Venlo. There I have to read 22 reports, of 14 students that
I coach and 8 others where I am the examiner. That incentivesed me to
Hogeschool Venlo. There I have to read 22 reports, from 14 students that
I coach and 8 others where I am the examiner. That incentivised me to
write down some advice. Here you have it.

\section{Do not bore us to death!}
Expand All @@ -41,24 +41,24 @@ \section{Things to avoid}
\begin{Description}
\item[Stay DRY] DO NOT repeat stuff.\gls{DRY}
\item[Good titles] Think of good chapter and section titles. We read
and use the table of content. If the chapter and section titles are
and use the table of contents. If the chapter and section titles are
good, they help explain the structure of the report, without any
extra boring help.\Margin{Good titles}
\item[Be brief] You do not get paid per written word, nor are we paid per word \textbf{read}.\Margin{brief}
\item[Use a storyline] Both in your report and in your
presentation. If you invent a \define{\gls{persona}} anyway, use him or her as the
protagonist to tell the store, and use him/her to explain stuff.
The story need not necessarily be true to the actual chronology of the
time spent in your bachelor project, but should be logical story, in
time spent on your bachelor project, but should be a logical story, in
which you take the reader along to explain your reasoning, the
decisions you made and why, etc.
\end{Description}

Your protagonist may not be useful in all the parts, but might be very
handy to explain the problem, assignment and how he or she can use the
fruits of your labour.
handy to explain the problem, and assignment and how he or she can use the
fruits of your labor.

Start with the \textbf{company} and every detail of that company which is relevant to the project.
Start with the \textbf{company} and every detail of that company that is relevant to the project.
Then continue with the \textbf{context} of the problem, exactly as
much as you need to explain the next logical thing: the
\textbf{problem} that you have been asked to solve. Followed by the
Expand All @@ -72,18 +72,18 @@ \section{Things to avoid}
flow.

As an example, If you need to explain what a typical customer will do
with the product, then we expect that you have explained product and
with the product, then we expect that you have explained the product and
customer in the company description or context.

You should assume the reader to be a single pass compiler (like
You should assume that the reader is a single-pass compiler (like
\LaTeX\ a C- or Pascal compiler). What has not been defined before
cannot be used.

Forward references (like: "as you will see in ...") are \textbf{not
allowed}. It is a waste of words, in particular when the structure,
and thus the table of content is any good.
and thus the table of contents is any good.

In this way you will keep the reader in his flow, because he does not
In this way, you will keep the reader in his flow because he does not
have to page forward or backward, and if the story is short enough,
the reader will be able to pull through without being bored to death.

Expand All @@ -92,7 +92,7 @@ \section{Things to avoid}

\section{TLDR;}\gls{TLDR}

In the remainder of this document you will see some tips and tricks to
In the remainder of this document, you will see some tips and tricks to
use when you write your report in \LaTeX, but the above and some
things in the use of graphics also apply when you use \textbf{Word} or
some other text processing application. The quality of your report
Expand All @@ -118,28 +118,28 @@ \section{Use a better technology}
starting point is \url{http://en.wikibooks.org/wiki/LaTeX}, useful for
beginners and pros alike. The help pages on overleaf are also quite good.

This is a simple multi part document. It's purpose is to show how easy it is
to create a multi part document, one that, for instance, can be worked on
This is a simple multi-part document. Its purpose is to show how easy it is
to create a multi-part document, one that, for instance, can be worked on
simultaneously by several authors. Note that most of the settings for
this document are set in the file \texttt{configuration/thesis\_config.tex}.
Look in that file too.

You are kindly advised to keep your lab logs in simple text
files. These can be turned into latex files easily,
which can be used to produce a nice looking report.
which can be used to produce a nice-looking report.
%\clearpage
\section{Some hints to start with}
Sometimes things do not work out the way you think.
\LaTeX\ interprets some character codes in it's own way.
\LaTeX\ interprets some character codes in its way.
Things like dollar signs or even underscore are special.
\LaTeX\ source are littered with accolades or \textit{curly braces} if that's
\LaTeX\ sources are littered with accolades or \textit{curly braces} if that's
the way you call them. They are special too. So here is some advice:

Do not use \define{funny file names}. That is: stick to ASCII filenames without spaces or even underscores.
These will bring only you into trouble. If you want to keep things portable,
These will lead you only into trouble. If you want to keep things portable,
don't use camel case (like in JavaClassNames) either, because
some OS-es do not distinguish between upper and lower case. You may of
course brake this rule if the files are program things like
course break this rule if the files are program things like
Java source files.

\subsection{Hints for informatics (use version control)}
Expand Down
Binary file modified docs/main.pdf
Binary file not shown.

0 comments on commit af8d7a3

Please sign in to comment.