Skip to content

Commit 9ffd66d

Browse files
authored
Merge pull request #22 from exaexa/mk-soak-in-rp
soak in the translation of the "semestral project" guide
2 parents f97729b + b69bfa7 commit 9ffd66d

File tree

4 files changed

+67
-15
lines changed

4 files changed

+67
-15
lines changed

.github/workflows/main.yml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ jobs:
1515
container: { image: 'aergus/latex' }
1616

1717
steps:
18-
- uses: actions/checkout@v3
18+
- uses: actions/checkout@v5
1919
- name: Build the thesis
2020
run: latexmk thesis && latexmk abstract-cz && latexmk abstract-en
2121
- name: Upload artifacts
22-
uses: actions/upload-artifact@v3
22+
uses: actions/upload-artifact@v4
2323
with:
2424
name: Thesis
2525
path: |
@@ -29,10 +29,11 @@ jobs:
2929
name: Verify PDF/A
3030
runs-on: ubuntu-latest
3131
needs: build
32-
container: { image: 'ghcr.io/mff-cuni-cz/cuni-thesis-validator' }
32+
container: { image: 'ghcr.io/exaexa/cuni-thesis-validator' }
3333

3434
steps:
3535
- name: Get PDFs
36-
uses: actions/download-artifact@v3
36+
uses: actions/download-artifact@v5
3737
- name: Run VeraPDF
38-
run: verify Thesis/*.pdf | tee /dev/stderr | grep -qE 'nonCompliant="0" failedJobs="0"'
38+
run: |
39+
verify *.pdf | tee /dev/stderr | grep -qE 'nonCompliant="0" failedJobs="0"'

ch1.tex

Lines changed: 52 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,61 @@
1-
\chapter{Important first chapter}
1+
\chapter{Introduction to thesis writing}
22
\label{chap:refs}
33

4+
% this section is translated from https://e-x-a.org/rp/
5+
% (thanks go to Jiri Benes for the initial translation)
6+
7+
If you are reading this, you likely have to write a thesis to finish your Bachelor or Master studies. First, congratulations on getting this far! What is a thesis though?
8+
9+
A thesis is a monograph, a longer writing about a given single topic of choice. The topic is typically implied by the area of your studies --- at the school of computer science, you will write about solving a problem with computers, at medical school you will write about an issue of health or anatomy, etc. To create the thesis, you typically proceed as follows:
10+
\begin{enumerate}
11+
\item You conduct a moderate review of current (or recent) \emph{academic literature} on a specific topic,
12+
\item with the acquired knowledge, you solve a narrowly specialized and \emph{well-defined problem},
13+
\item through standard and \emph{reproducible methods}, you determine the quality of your solution,\item and finally, you express the entire story \emph{comprehensibly}, clearly, and lucidly in a 20- to 60-page book, which becomes your thesis.
14+
\end{enumerate}
15+
16+
By submitting a thesis, student proves that they are capable of understanding the results of recent research, using them to scientifically guide and analyze their own work, and communicating the outcome comprehensibly to others.
17+
18+
The work on the thesis is best started by finding a supervisor and agreeing on the topic. You will typically need to write an annotation of the thesis, which comprises a condensed summary of the main idea and expected results. The annotation is submitted to your institute's administration, and after some time, you will be officially assigned a task of completing the thesis.
19+
20+
Before the thesis is assigned, you usually prepare yourself for the main work; e.g., by testing all the software libraries, tools, and methods that you will need, exploring your target domain, environment and subjects, creating and testing various prototypes and proof-of-concepts, reading relevant academic literature, and refining your approach (and the thesis annotation) based on initial findings. The preparation phase is quite crucial, as it allows you to discover many potential roadblocks and refine your approach \emph{before} committing to the full thesis. Generally, the work conducted in advance gives you much better chance to finish the thesis without surprises later. For similar reasons, one of the main tasks of the supervisor is to know the roadblocks that you do not see yet, and prevent you from committing to a thesis that is not finishable or defendable.
21+
22+
\section{How to recognize a good thesis topic?}
23+
24+
Before you officially register a thesis --- and ideally before you start committing to the task at all --- you should know the concrete instances of terms highlighted in the points 1--4 above. In particular, you should be able to clearly answer the following questions:
25+
26+
\begin{description}
27+
\item[Is my idea even relevant?]
28+
To get the answer, go to Scholar\footnote{\url{https://scholar.google.com/}, or any other scientific literature search tool} and try to find articles that are not too old (say, at most 15--20 years, depending on the area), are not visibly outdated, and are relevant to your topic. If you cannot find any recent academic work on your topic, it might be too niche, already solved, or not academically interesting. Your supervisor will often help you find the latest research in the area.
29+
\item[Is the problem I want to solve sufficiently ``hard''?]
30+
No one expects you to produce a completely new and revolutionary solution to your problem. The method for solving your problem should be known and already explored --- in particular, you are not expected to make any groundbreaking scientific discoveries! You should ``just'' properly use the existing methods in a slightly novel context of your problem. For example, you may apply a known approach in a way that no one has tried before, slightly modify the approach to enable use in a seemingly different domain, or combine existing approaches in a novel way. In other words: the problem should be non-trivial, but you should know in advance how to approach the solution.
31+
\item[Is the problem well-defined?]
32+
Solve one problem, and solve it well. You will often encounter a thesis reviewer telling you that your problem is not really a problem --- this is especially common for theses with topics such as ``I'll make a video game about X''. To provide an answer, you must have a direct, undeniable proof that your problem is relevant and its solution constitutes at least a minor advancement in some area (ideally, the world will be much more beautiful and civilization will be better off with the problem solved). Ideally, you will be able to point out existing academic literature that states that your topic is indeed a problem worth solving.
33+
\item[How will I explain the problem to others?]
34+
Write the main problem of your thesis down as a \emph{hypothesis}, and design an \emph{experiment} that you can conduct to either confirm or reject this hypothesis, or to clearly determine the boundaries of its validity. Some theses are not experiments per se, but may be easily reworded as a case study, user testing, performance analysis, exploratory work, or theoretical proof. Mainly, the hypothesis--experiment wording helps you to convey the difficulty of the task, and clearly point out the ``unknowns'' that you aim to uncover.
35+
\item[Am I trying to solve an exceedingly hard problem?]
36+
Am I perhaps solving multiple problems at once? In such cases, you might be shooting yourself in the foot: You will lose a lot of time on something that is not necessary, and your thesis reviewer will get annoyed trying to spot the single problem that you are solving. If your thesis addresses multiple smaller problems, you must correctly frame them in a single, well-defined and topically consistent group of problems.
37+
\item[How do I present my results?]
38+
In your thesis, you will have to prove that you actually solved something, and reviewers will, by default, actively doubt that you accomplished anything meaningful. Prepare a clear method for evaluating your results. In computer science, the most common evaluation methods include performance measurements (speed, memory usage, accuracy), comparative analysis (how does your solution compare to existing approaches?), case studies (real-world applications of your solution), user studies (how do people interact with and benefit from your work?), and theoretical analysis (including mathematical proofs and logical arguments). It is extremely useful to show plots, statistics, and various other visualized evidence.
39+
\item[How do I interpret my results?]
40+
Ideally, you will compare your results with ones from people who solved similar problems. Besides measuring your own solution, you might also need to measure the alternative implementations and approaches, use a comparable measurement methodology (benchmark) to allow comparison to other benchmarked work, and ensure fair comparison conditions. \emph{However, no one expects you to win this comparison!} A negative result is also a result, and thesis reviewers will understand it. Conversely, they will show no understanding for irreproducible measurements or unfair comparisons.
41+
\item[How will I fill all these pages with text?]
42+
Can you write 20--60 moderately amusing pages about your work? If not, you will be able to gain inspiration from reading academic literature thoroughly and elaborating on your findings (see above), conducting your own experiments and analysis, and reflecting on the broader implications of your work. Typically, you can write a lot of good text simply by reviewing 2--3 research papers that your thesis builds upon, and re-framing them into the context of your problem.
43+
\item[Am I doing it right?]
44+
To understand what is typically expected, look at some of the completed theses in your field. Look into thesis repositories from your institution,\footnote{\url{https://dspace.cuni.cz/} for Charles University} examine what makes a thesis successful, and observe the different approaches to similar problems, writing styles and organizational structures. To get a good picture of the common issues and expectations, read the official reviews from supervisors and reviewers (these are typically deposited along with the thesis).
45+
\item[Am I finishing it in time?]
46+
Allocate a lot of time for writing, editing, and making good pictures. At the \emph{extreme barest minimum}, allocate at least one full month of work for fixing and incorporating the comments from your supervisor, especially if you never wrote a thesis before. Do not expect supervisors to read your input immediately, they generally do not have time for that --- instead, reserve at least a week for each revision. Check the thesis submission requirements in advance --- in particular, if you are supposed to print your thesis on paper, order the printing service with sufficient time reserve.
47+
\item[Who will tell me what to do next?]
48+
You will. Remember that it is \emph{your} thesis --- while your supervisor (and others) will try to guide you, it is ultimately you who is responsible for your own work (and success). You are thus expected to take initiative; and many would argue that the main point of the theses is precisely to \emph{show the initiative}. In particular, never wait for your supervisor to give you tasks. Be proactive, work independently, solve issues well before deadlines, workaround issues early to avoid getting stuck, come to meetings equipped with prepared questions and clearly summarized progress updates and milestones, and bring up your own ideas about next steps. Make sure that your topic motivates you into taking the initiative.
49+
\end{description}
50+
51+
\section{What to put into the first chapter?}
52+
453
First chapter usually builds the theoretical background necessary for readers to understand the rest of the thesis. You should summarize and reference a lot of existing literature and research.
554

655
You should use the standard \emph{citations}\todo{Use \textbackslash{}emph command like this, to highlight the first occurrence of an important word or term. Reader will notice it, and hopefully remember the importance.}.
756

857
\begin{description}
9-
\item[Obtaining bibTeX citation] Go to Google Scholar\footnote{\url{https://scholar.google.com}}\todo{This footnote is an acceptable way to `cite' webpages or URLs. Documents without proper titles, authors and publishers generally do not form citations. For this reason, avoid citations of wikipedia pages.}, find the relevant literature, click the tiny double-quote button below the link, and copy the bibTeX entry.
58+
\item[Obtaining bibTeX citation] Go to Google Scholar\footnote{\url{https://scholar.google.com}}\todo{This footnote is an acceptable way to `cite' web pages or URLs. Documents without proper titles, authors and publishers generally do not form citations. For this reason, avoid citations of Wikipedia pages.}, find the relevant literature, click the tiny double-quote button below the link, and copy the bibTeX entry.
1059
\item[Saving the citation] Insert the bibTeX entry to the file \texttt{refs.bib}. On the first line of the entry you should see the short reference name --- from Scholar, it usually looks like \texttt{author2015title} --- you will use that to refer to the citation.
1160
\item[Using the citation] Use the \verb|\cite| command to typeset the citation number correctly in the text; a long citation description will be automatically added to the bibliography at the end of the thesis. Always use a non-breakable space before the citing parenthesis to avoid unacceptable line breaks:
1261
\begin{Verbatim}
@@ -38,7 +87,7 @@ \section{Some extra assorted hints before you start writing English}
3887
Strictly adhere to the English word order rules. The sentences follow a fixed structure with a subject followed by a verb and an object (in this order). Exceptions to this rule must be handled specially, and usually separated by commas.
3988

4089
\paragraph{Sentence structure}
41-
Do not write long sentences. One sentence should contain exactly one fact. Multiple facts should be grouped in a paragraph to communicate one coherent idea. Both the sentences and paragraphs should include various hints about their relation to the other ideas and paragraps. These are typically materialized as adverbs or short sentence parts that clarify the cause--outcome and target--method--result relationship of the sentences in a paragraph. Such `word glue' helps the readers to correctly draw the lines that hold their mental images of your thesis together, and ideally see the big picture of what you were trying to convey right from the first read.
90+
Do not write long sentences. One sentence should contain exactly one fact. Multiple facts should be grouped in a paragraph to communicate one coherent idea. Both the sentences and paragraphs should include various hints about their relation to the other ideas and paragraphs. These are typically materialized as adverbs or short sentence parts that clarify the cause--outcome and target--method--result relationship of the sentences in a paragraph. Such `word glue' helps the readers to correctly draw the lines that hold their mental images of your thesis together, and ideally see the big picture of what you were trying to convey right from the first read.
4291

4392
Paragraphs are grouped in labeled sections for a sole purpose of making the navigation in the thesis easier. Do not use the headings as `names for paragraphs' --- the text should make perfect sense even if all headings are removed. If a section of your text contains one paragraph per heading, you might have wanted to write an explicit list instead.
4493

intro.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
\item What can the reader expect in the individual chapters of the thesis?
1111
\end{enumerate}
1212

13-
Expected length of the introduction is between 1--4 pages. Longer introductions may require sub-sectioning with appropriate headings --- use \texttt{\textbackslash{}section*} to avoid numbering (with section names like `Motivation' and `Related work'), but try to avoid lengthy discussion of anything specific. Any ``real science'' (definitions, theorems, methods, data) should go into other chapters.
13+
Expected length of the introduction is between 1--4 pages. Longer introductions may require sub-sectioning with appropriate headings --- use \verb|\section*| to avoid numbering (with section names like `Motivation' and `Related work'), but try to avoid lengthy discussion of anything specific. Any ``real science'' (definitions, theorems, methods, data) should go into other chapters.
1414
\todo{You may notice that this paragraph briefly shows different ``types'' of `quotes' in TeX, and the usage difference between a hyphen (-), en-dash (--) and em-dash (---).}
1515

1616
It is very advisable to skim through a book about scientific English writing before starting the thesis. I can recommend `\citetitle{glasman2010science}' by \citet{glasman2010science}.

thesis.tex

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,19 @@
1515
%\usepackage[textwidth=145mm,textheight=247mm]{geometry}
1616

1717
%%% TYPICAL FONT CHOICES (uncomment what you like) %%%
18-
% Recommended combo: Libertinus (autoselects Biolinum for sans) and everything
19-
% else (math+tt) comes from Latin Modern)
20-
\usepackage{lmodern}
21-
\usepackage[mono=false]{libertinus}
2218

2319
% For the "classic" LaTeX fonts (very good for pure math theses), simply
24-
% comment out the libertinus package above.
20+
% comment out any other font choices.
21+
22+
% Recommended combo: Libertinus (autoselects Biolinum for sans), typewriter
23+
% font comes from AnonymousPro. If you like libertinus a lot, you can try the
24+
% mono font from Libertinus too -- simply remove the `mono=false` argument.
25+
% `StretchTT=1` seems required to make the PDF/A validation pass.)
26+
\usepackage[mono=false,StretchTT=1]{libertinus}
2527

2628
% IBM Plex font suite: nice, but requires us to fine-tune the sizes and does
2729
% not directly support small caps (\textsc):
28-
%\usepackage[usefilenames,RM={Scale=0.88},SS={Scale=0.88},SScon={Scale=0.88},TT={Scale=0.88},DefaultFeatures={Ligatures=Common}]{plex-otf}
30+
%\usepackage[RM={Scale=0.88},SS={Scale=0.88},SScon={Scale=0.88},TT={Scale=0.88},DefaultFeatures={Ligatures=Common}]{plex-otf}
2931

3032
% TeX Gyre combo (Pagella+Heros+Cursor)
3133
%\usepackage{fontspec}

0 commit comments

Comments
 (0)