How to Write Jun. Prof. Alexander Markowetz
How to Write
Jun. Prof. Alexander Markowetz
How to Write
●
Writing Science
●
Structuring the Paper
●
Its Sections
●
Writing Paragraphs
●
Writing Sentences
●
Formatting
Writing Science
●
We do not write poetry
●
You do not have to be a “genius”
●
Small vocabulary
●
Few expressions
●
It can be formalized
●
Following the formalism will yield a readable paper
Jun.Prof. Alexander Markowetz - How to Write
3
Formalism
●
Be creative in your scientific ideas
●
Do NOT be creative about the presentation
●
This is a conservative business
●
Follow the rules!
●
Once you are a tenured professor, you may
deviate from the rules
●
But probably would not want to
Jun.Prof. Alexander Markowetz - How to Write
4
Formalism
●
I am soooo creative
●
●
My work is amazing, it needs more pages
●
●
Stick to the rules
Stick to the page limit
But then I have to leave out most of my
innovations...
●
No, you don't
●
We will preserve all content
●
Brevity will further increase readability
Jun.Prof. Alexander Markowetz - How to Write
5
Haikus
●
Traditional Japanese poetry (since 700 AC)
●
First part of a Tonka
●
Fixed schema
●
Three lines
●
Five moras (~ syllables)
●
Seven moras
●
Five moras
Jun.Prof. Alexander Markowetz - How to Write
6
Haikus
●
●
初しぐれ
猿も小蓑を
ほしげ也
the first cold shower
even the monkey seems to want
a little coat of straw
Bashō
Jun.Prof. Alexander Markowetz - How to Write
7
Haikus
●
●
富士の風や
扇にのせて
江戸土産
the wind of Mt. Fuji
I've brought on my fan!
a gift from Edo
Bashō
Jun.Prof. Alexander Markowetz - How to Write
8
Haikus
●
The schema is super restrictive
●
Yet, it induced awe inspiring poetry
●
Similarly, think of the formalism in your paper
●
It makes for a more elegant paper
Jun.Prof. Alexander Markowetz - How to Write
9
No Mistakes, No Excuses
●
Picture a reviewer
●
An insanely busy professor
●
He receives 15 papers to review for a conference
●
He ignores them for the next seven weeks
●
Now he has one week to write the reviews
●
He will want to reject your paper
●
Quickly
●
To get it of his desk
●
Preferably on formal grounds
Jun.Prof. Alexander Markowetz - How to Write
10
No Mistakes, No Excuses
●
Don't give any excuse to reject your paper
●
Make no obvious mistakes
●
Do not leave any “holes”
●
Leave a good first impression
●
●
Visually, with a clean layout
●
Textually, in clean short sentences, sound orthography
Now he knows:
●
“This is a decent paper, I have to take a closer look.”
Jun.Prof. Alexander Markowetz - How to Write
11
Take Responsibility
●
●
●
Getting your paper accepted is your
responsibility
It is not the fault of the reviewer if he does not
appreciate or understand your paper
It is your responsibility to make it attractive
Jun.Prof. Alexander Markowetz - How to Write
12
Mathematicians Cannot Write
●
Definition 1
●
Definition 2
●
Lemma 1
●
Lemma 2
●
Theorem
Finally they tell us what
they are trying to achieve
Jun.Prof. Alexander Markowetz - How to Write
13
We Often Share these Troubles
●
Describe Software Component 1
●
Describe Software Component 2
●
Describe Software Component 3
●
Describe Software Component 4
●
Putting it together,
we can do this-and-that
Finally, ... the purpose
of the system
Jun.Prof. Alexander Markowetz - How to Write
14
Problem Driven Writing
●
Start With the Problem
●
Then show the solution
●
From the big picture, drill down to detail
–
–
–
–
–
–
This is the problem P
To solve P we have to solve sub-problems SP1 and SP2
To solve SP1, we must solve sub-prob. SP1.1 and SP1.2
After solving SP1.1 and SP1.2, we have solved SP1
Next, we solve SP2
We solved SP1 and SP2, and thus the original problem
Jun.Prof. Alexander Markowetz - How to Write
15
Problem Driven Writing
●
Start with the problem
●
After all, we are engineers
●
Our day starts with a problem
●
And ends with a solution
Jun.Prof. Alexander Markowetz - How to Write
16
Storytelling 101
Most Important
IN
BODY
OUT
Biggest
Jun.Prof. Alexander Markowetz - How to Write
17
IN
●
●
You introduce
●
The problem
●
The setting
●
Your solution
Pick-up reader at his present knowledge
●
Do not assume previous knowledge
●
Tell him what you will show him next
●
Shaped like a funnel
●
Start with the very big picture
●
Gradually drill down on detail
Jun.Prof. Alexander Markowetz - How to Write
18
BODY
●
Say what you have to say
●
Deliver what you promised in IN
●
In a linear fashion
Jun.Prof. Alexander Markowetz - How to Write
19
OUT
●
Summarize the Body
●
Place it in a broader picture
●
Provide an outlook to the future
Jun.Prof. Alexander Markowetz - How to Write
20
Classic Western
●
IN
●
Introductory wide-angle shot:
●
A market square in a dusty Western town
●
Two men facing each other
Close-up Shot: Eyes
●
●
Close-up: hands on guns
●
B
O
D
Y
OUT
They hate each other
They will shoot each other
●
Some conversation
●
Some shooting
●
One dies
●
Lonely sheriff mounts his horse and rides into sunset
●
This part actually takes the longest.
He will face new adventures
Jun.Prof. Alexander Markowetz - How to Write
21
Writing Recursively
●
Apply the above model recursively
●
Top-Down
●
Divide the paper into sections
–
●
Divide sections into paragraphs
–
●
Introduction, some more sections, conclusion
Introductory paragraph, some more, a final one to summarize and connect
Divide paragraphs into sentences
–
Thesis sentence, body of evidence, final sentence
●
The paper thus assumes a tree-structure
●
For every node, know precisely what you want to say
●
You can collect your thoughts in the nodes, before you decent
and write them out in full length
Jun.Prof. Alexander Markowetz - How to Write
22
Budget Your Text
●
Each node is associated with a space budget
●
The space you can afford to get your point across
●
Know the space budget before you start writing
●
A section can only be so-and-so long
●
●
A paragraph can only have a certain length
●
●
Variable, depending on the section
Fixed, due to human capacity
A sentence has a maximal length
●
Fixed
Jun.Prof. Alexander Markowetz - How to Write
23
Linear Writing
●
Writing is linear
●
Not circular, or jumpy
●
You must bring your points into a linear order
●
You may encounter circular dependencies
●
●
Between software components
Cut smartly, and order them linearly
Jun.Prof. Alexander Markowetz - How to Write
24
Be Concise
●
Say everything precisely ONCE
●
●
●
Never, repeat anything
Remove any content that does not directly
support your argument
Use as little words as possible
Jun.Prof. Alexander Markowetz - How to Write
25
The Mantras
●
“The point, the point, get to the f***ing point!”
●
“The crap, the crap, cut the f***ing crap!”
●
Recite these, while you write
●
This builds character
●
And makes you a better writer
Jun.Prof. Alexander Markowetz - How to Write
26
Now we know the basic rules of writing
Next, let's look at how to structure a paper
Jun.Prof. Alexander Markowetz - How to Write
27
Structure of the Paper
1) Abstract
2) Introduction
3) Related Work
4) Formal Problem Statement & Definitions
5) Algorithms
6) Further Optimizations
7) Experiments
8) Conclusion and Future Work
9) Bibliography
Jun.Prof. Alexander Markowetz - How to Write
28
Structure of the Paper
1) Abstract
IN
2) Introduction
3) Related Work
B
O
D
Y
4) Formal Problem Statement & Definitions
5) Algorithms
6) Further Optimizations
7) Experiments
OUT
8) Conclusion and Future Work
9) Bibliography
Jun.Prof. Alexander Markowetz - How to Write
29
The Budget
12 page paper
1) Abstract
~ 3p
2) Introduction
3) Related Work
4) Formal Problem Statement & Definitions
~5
5) Algorithms
6) Further Optimizations
~ 2p
~ 2p
Ideas from
other people
are restricted
to these
three pages
Your
Contribution
is measured
in pages
7) Experiments
8) Conclusion and Future Work
9) Bibliography
Jun.Prof. Alexander Markowetz - How to Write
30
Not Everybody is Made Equal
●
Some sections are more important than others
●
Focus on the important ones
●
Reviewers read the paper in a certain order:
1) Abstract
2) Introduction
3) Conclusion
4) The rest of the paper
●
The first three are most important
Jun.Prof. Alexander Markowetz - How to Write
31
Now we finished the structure of the paper
Let's look inside the sections
Jun.Prof. Alexander Markowetz - How to Write
32
The Title
●
Cover the main points and contributions
●
Keep it short
●
Avoid:
●
“Towards ...”
●
“On …”
●
This is entirely redundant
Jun.Prof. Alexander Markowetz - How to Write
33
Author Lists
●
Ordered by the contribution
●
Commonly students first, professors later
●
●
●
First author is the main author
●
The paper should be based in his idea
●
He should do most of the work, and takes most credit
Second authors
●
●
Professors have a career, students still need publicity
Have done supporting writing and implementation
If you have two main authors
●
Switch positions for the next paper
Jun.Prof. Alexander Markowetz - How to Write
34
Abstract
●
180 – 200 words
●
ONE paragraph
●
Do not split into two or more paragraphs
●
Start with the problem setting
●
Then say what you do
●
How you do it
●
What is special about your system
●
I.e., your contribution
Jun.Prof. Alexander Markowetz - How to Write
35
Introduction
1) Motivate Problem
●
Why this is important in
the real world
4) Your solution
●
2) Explain problem
●
●
6) List contributions
Formally
Why this is of scientific
interest
3) Previous solutions
●
Briefly outline your
approach, techniques,
etc.
●
What is novel
8) Table of contents
Summarize and indicate
their shortcomings
Jun.Prof. Alexander Markowetz - How to Write
36
Motivation
●
Build a funnel
●
Start with the world
●
●
There are 7 Billion people
●
Some 500 million play computer games, especially on-line
Then gradually drill to the topic
●
●
Efficient server architectures are crucial for the profitability of a
gaming companies
One aspect that cannot be overestimated is moving data to
secondary storage ...
●
Now remove the first one or two sentences
●
You just finished the first paragraph
Jun.Prof. Alexander Markowetz - How to Write
37
Focus
●
The introduction is the most important section
●
Its first paragraph is the most important
●
Its first sentence is super-most important
●
Make sure all three are increasingly
●
Brilliant
●
Crisp
●
Bold
Jun.Prof. Alexander Markowetz - How to Write
38
Inside the Introduction
●
Examples are helpful
●
If you have one, illustrate it with a figure
●
Do not use equations
●
●
This goes to Section 3 and 4
Do not cite
●
You will give proper credit in Section 2
Jun.Prof. Alexander Markowetz - How to Write
39
Contributions
●
●
●
Finally, list your contributions
●
2-5 bullets, no more
●
Be brief, 1-3 sentences per bullet
Help the reviewer find the novelty in your paper
Bring him in a position where he cannot deny
that you are making a contribution
Jun.Prof. Alexander Markowetz - How to Write
40
Conclude Your Introduction
●
With a table of contents
●
Wrapped in a single paragraph
●
Formalized:
“The remainder of the paper is structured as
follows. Section 2 outlines related work and
previous system implementations. Then,
Section 3 introduced basic concepts and … .
Finally, Section 8 concludes the paper.”
Jun.Prof. Alexander Markowetz - How to Write
41
Related Work
●
All discussion of previous work should go here
●
In case you need formal concepts from previous work
●
●
Define them in Section 3
●
Clearly mark them as citation
After Section 2 (3), all content should be 100% yours
●
This should be after the 3rd page
●
Allow reviewer to estimate size (in pages) of contribution
●
DO NOT ever mix other people's ideas in Sections 4-8
Jun.Prof. Alexander Markowetz - How to Write
42
Related Work
●
●
●
Related work can be super messy
●
Different assumptions
●
Different requirements
●
Different notation
●
Especially, if the topic is new
You have to order (cluster) them
●
By timeline
●
By application area
●
By algorithmic approaches
Create and impose your frame of reference
Jun.Prof. Alexander Markowetz - How to Write
43
Related Work
●
Be polite (impartial) towards other people
●
Champion other people's work
●
Avoid negativity
●
If you have nothing positive to say, just write a short
neutral sentence:
“Markowetz et al [2009] investigate the topic from a spatiotemporal perspective.”
●
But, do not assume anything that is not clearly stated
●
●
Especially for confusing papers
Be firm regarding your contribution
Jun.Prof. Alexander Markowetz - How to Write
44
What to Cite
●
You need to cite all relevant papers
●
Show that you have read all relevant literature
●
You don't want your paper rejected because the
reviewer claims that you should have
“compared your work with the paper by XY et
al. [2009]”, when you have not cited the paper
Jun.Prof. Alexander Markowetz - How to Write
45
What to Cite
●
●
●
ALL relevant papers
●
From big conferences (ACM, IEEE, VLDB)
●
From leading journals (TODS, TOIS)
●
From specific workshops (WebDB, GeoIR)
Not necessary to cite
●
Posters
●
Minor workshops
●
Bullshit conferences
●
Textbooks
If its not in DBLP, it does not exist, … and needn't be cited
●
You don't have to cite technical reports, master of PhD theses
Unless you actively want to, for whatever reason.
Jun.Prof. Alexander Markowetz - How to Write
46
What to Cite
●
●
Sometimes there is a series of consecutive
workshop, conference and journal publications
●
The conference papers subsume the workshops
●
The journal papers subsume the conference onces
●
Its OK, just to cite the journal
Cite papers from members of your PROGRAM
COMMITTEE and their famous friends
Jun.Prof. Alexander Markowetz - How to Write
47
Inner Sections
●
Recursively
●
One paragraph to introduce
●
Some paragraphs to explain
●
One paragraph to conclude and connect
●
Order the inner paragraphs, before you write
●
Have a strategy before you touch the keyboard
Jun.Prof. Alexander Markowetz - How to Write
48
Subsections
●
●
●
You can divide longer sections in subsections
Essentially replace inner paragraphs with
subsections
Subsections are structured like sections
●
One paragraph to start
●
Some in the middle
●
One to conclude and connect
Jun.Prof. Alexander Markowetz - How to Write
49
Subsections
●
●
Do NOT use SubSubsections
Do not use two
consecutive headings
●
Put some text inbetween
Wrong:
●
Title of Section 4
●
Title of Section 4.1
●
Some text
Good:
●
Title of Section 4
●
●
A short paragraph
Title of Section 4.1
●
Some text
Jun.Prof. Alexander Markowetz - How to Write
50
Experiments: a Non-Empty Section
●
It is difficult (impossible) to make meaningful
experiments, especially in IR
●
What use is a user study, conducted on 25 PhD
students from a cs department?
–
–
Very small
Not representative
●
You still need to have an experimental section
●
Do not leave obvious excuses to kill your paper
Jun.Prof. Alexander Markowetz - How to Write
51
Use Real Data
●
Use real data whenever possible
●
You may use synthetic data to play with parameters
●
Use real data in parallel
●
Don't give an excuse to reject your paper
●
Use real queries whenever possible
●
Be careful, if you have to create synthetic queries
●
●
Equally important effectiveness and efficiency
Don't randomly pair terms to create two-word queries
Jun.Prof. Alexander Markowetz - How to Write
52
Start the Experiments
●
Outline the section
●
Explain experimental setup
●
Data
●
Queries?
●
Users?
●
Machine
●
Evaluation metric
–
●
CPU consumption, memory consumption, precision, recall,
Parameter under investigation
●
Number of terms in query
●
Number of concurrent users
●
Etc.
Jun.Prof. Alexander Markowetz - How to Write
53
The Actual Experiments
●
Fix all parameters at default values, alter one
●
Write like a forensic scientist
●
State the obvious
–
●
“As shown in Figure 3, the number of false positives quadratically
increases with the number of drunken participants.”
Then explain why this happens
–
“This is due to... “”
●
Explain the impact of one parameter
●
Then show the figure with the graphs
●
Then continue to the next parameter
Jun.Prof. Alexander Markowetz - How to Write
54
Finish the Experiments
●
Summarize your experimental findings
●
All in all …
●
●
How is your system expected to behave in a
different environment?
Give recommendations to someone who builds
a similar system
Jun.Prof. Alexander Markowetz - How to Write
55
Conclusion & Future Work
●
Summarize your paper and contribution
●
Briefly
●
“The introduction in past tense”
●
Place your work in a broader picture
●
Indicate the direction in which it could move
●
Do not give away concrete ideas
●
●
Someone will steal them
Do not mention obvious next steps
●
The reviewer will ask, why they are not in the current paper
Jun.Prof. Alexander Markowetz - How to Write
56
Formatting the Bibliography
●
Research all relevant information
●
●
Including the conference, city, page-number, etc.
Homogenize the format
●
●
If you use full first-names once, do so in all entries
If you call it ACM SIGMOD once, do not call it “the ACM
SIGMOD International Conference on Management of
Data” in another entry
●
Actually, keep the same format for all ACM conferences
●
In Bibtex, protect upper-caps by using {PARENTHESES}
Jun.Prof. Alexander Markowetz - How to Write
57
Now we finished sections.
Next: paragraphs.
Jun.Prof. Alexander Markowetz - How to Write
58
Save your words
●
Use as little words as possible
●
Can you remove this sentence?
●
Can you remove this word?
●
●
Can you replace this word sequence with a
shorter one?
Can you replace this word with another one that is
more precise?
Jun.Prof. Alexander Markowetz - How to Write
59
Painter vs. Surgeon
●
A painter smears
paint up and down,
●
then left and right
then up and down
●
In the end, he has
“covered” all areas
●
A surgeon makes
small, precise cuts
●
Minimal
●
Effective
He gets things done
with minimal efforts
You want to be a surgeon.
Think of every word, and every sentence as an incision.
Jun.Prof. Alexander Markowetz - How to Write
60
The Paragraph
●
The paragraph is a unit of meaning
●
Larger than a single sentence
●
Smaller than a section or chapter
●
Thus, it conveys a single organized thought
●
It commonly contains several sentences
●
Yet, it is reasonably short.
●
10 sentences
●
200 words
Jun.Prof. Alexander Markowetz - How to Write
61
The Paragraph
●
Is similar to a programming function
●
It provides a small and precise functionality
●
●
Function: it does something
●
Paragraph: carries ONE thought
It is described by its first line of text
●
Function: signature
●
Paragraph: thesis sentence
Jun.Prof. Alexander Markowetz - How to Write
62
The Structure of a Paragraph
Thesis Sentence
Body of Support
Last Sentence
Jun.Prof. Alexander Markowetz - How to Write
63
The Thesis Sentence
●
●
●
●
Summarizes the meaning of the paragraph
States the hypothesis that you will further
explore in the rest of the paragraph
The system by [AB99] is a complete disaster.
First, it fails more often than not. Second, …
Although the systems fails, it made a significant
contribution. Most notably, it illustrated how ....
In addition, it did something weird.
Jun.Prof. Alexander Markowetz - How to Write
64
The Body of Support
●
Illustrates why the thesis sentence is true.
●
Provides the argument in full length.
●
Provides examples and further evidence.
Jun.Prof. Alexander Markowetz - How to Write
65
The Last Sentence
●
Can summarize the paragraph.
●
Or provide a transition to the next paragraph.
●
Sometimes, it may be missing; i.e., the last
sentence is still part of the body of support.
Jun.Prof. Alexander Markowetz - How to Write
66
Structure a Paragraph
●
Think WHAT you want to write
●
●
●
Do not start before you know what you want to say
Lay out the structure.
●
What is the topic of the paragraph?
●
What are the arguments in its support?
●
How are these best ordered linearly?
Then, start writing.
Jun.Prof. Alexander Markowetz - How to Write
67
Now we finished paragraphs.
Let's look at how to write sentences.
Jun.Prof. Alexander Markowetz - How to Write
68
Direct Speech
●
Avoid passive speech, like in the following BAD
examples:
●
●
●
The data is cleaned by the next component.
These experiments were devised to show the
extreme benefits of our algorithm.
Instead, use active speech:
●
●
The next component cleans the data.
The experiments show the extreme benefits of our
algorithm.
Jun.Prof. Alexander Markowetz - How to Write
69
Use Present Tense
●
Consistently use present tense
●
Avoid past or future tense (… the other two tenses).
●
●
BAD: Later sections will show how to accelerate the
system.
GOOD: Later sections show how to accelerate the
system.
●
BAD: This data structure was too slow.
●
BETTER: This data structure is too slow.
Jun.Prof. Alexander Markowetz - How to Write
70
Short Sentences (1)
●
A sentence should have at most two parts, like
in the following examples:
●
●
●
The system performs poorly, even though we are
genius scientists.
The algorithm, shown to be incorrect, is hailed as a
major breakthrough.
And NOT like this:
●
Although entirely unnecessary, we perform several
tests, and prove the algorithm, which has been
shown to be incorrect, to be quite efficient.
Jun.Prof. Alexander Markowetz - How to Write
71
Short Sentences (2)
●
In particular, do not use cascading subclauses,
like the following:
●
●
●
The system, which has been shown to fail frequently,
although it has been tested extensively, and never
really works, finally is put to sleep.
We devise large scale experiments, that run on a
database, which is filled with synthetic data, in order to
prove its poor performance.
Actually, there are no commas before “that”, I just
put some to illustrate a sub-clause
Jun.Prof. Alexander Markowetz - How to Write
72
Short Sentences (3)
●
Just count the number of words.
●
If the sentence has too many, it should be split.
●
This sentence is too long:
We thereafter slowly continued to enlarge the
already excessive number of over-sized spatial
data points from our earlier preliminary
experimental setup.
Jun.Prof. Alexander Markowetz - How to Write
73
Never Repeat a Word
●
Never repeat a word within the same sentence.
Like in these BAD examples:
●
●
●
One particularly bad example is the following
example.
The system is robust against network failure or
misconfiguration of system properties.
Do not even repeat similar words:
●
●
We store the data in a database.
In the follow-up paper to [MYP07], the authors
showed the following theorem.
Jun.Prof. Alexander Markowetz - How to Write
74
Words in Consecutive Sentences
●
Avoid using the same word in two consecutive
sentences. Like in these bad examples:
●
●
We download 100,000 web pages. Then, we store
the web pages in a special repository.
We designed the system to scale to arbitrary size.
Therefore, the system lends itself particularly well to
certain applications.
Jun.Prof. Alexander Markowetz - How to Write
75
Avoid Colloquial English
●
●
In particular, do not use:
●
Stuff
●
A lot
●
Many
●
Much
Think of something smart, like:
●
Numerous
●
Substantial
●
Significant
●
etc.
Jun.Prof. Alexander Markowetz - How to Write
76
Very
●
●
Avoid the word “very”
You may only use it, if otherwise, you'd be
saying:
●
Damn
Or
●
F***ing
Jun.Prof. Alexander Markowetz - How to Write
77
Which Hunting
●
Avoid the word “which”
Like in these BAD examples:
●
●
●
●
The system, which was designed by geniuses,
failed frequently.
The genius held on to his strategy, which was not
very smart.
Avoid “which” at all cost
After you finish writing, go “which”-hunting, and
replace all occurrences
Jun.Prof. Alexander Markowetz - How to Write
78
Numbers, Symbols and Equations
●
Never use numbers, symbols, equations or
citations at the beginning of a sentence
●
Nor directly next to each other
●
Like in these BAD examples:
●
S is a set of things.
●
4 students are not as smart as one professor
●
●
Next, we reduced the size of S, T however remained
unchanged.
The poorest design was published in [XYZ99]; [AB07]
however performed significant research.
Jun.Prof. Alexander Markowetz - How to Write
79
Abbreviations
●
Are best avoided at the beginning of a sentence
●
●
WWW pages commonly contain pornography.
Do not have a plural “s”
●
The ROVs are submerged to a depth of 1000m.
●
The ROV are submerged to a depth of 1000m.
Jun.Prof. Alexander Markowetz - How to Write
80
Introducing Abbreviations
●
Introduce the concept in italics
●
Followed by the abbreviation
●
●
Like so:
●
●
●
In parentheses, not in italics
The armored battle vehicle (ABV) is …
The authors of [AB99] introduce the notion of an
grumpy algorithm (GA), akin to ....
If you introduce a concept in the introduction, you
may have to do it a second time in a later section,
when you are really going to use it.
Jun.Prof. Alexander Markowetz - How to Write
81
Optimality
●
●
Optimal, and Optimality are fixed concepts in
computer science
NEVER use these words, unless you provide a
formal proof that your algorithm is indeed
asymptotically optimal
Jun.Prof. Alexander Markowetz - How to Write
82
Objects, Functions and Systems
●
●
●
These words are so generic, they could mean
anything
They thus lead to vague writing and confuse
the reader
Use more specific terms whenever possible
Jun.Prof. Alexander Markowetz - How to Write
83
i.e. Id Est
●
●
Means “that is”, or
●
"that means"
●
"which means"
●
"in other words"
And is used like this:
●
We then increase the dataset set further, i.e., we introduce
another million points.
●
Note the use of commas after the abbreviation.
●
Never start a sentence with i.e.
Jun.Prof. Alexander Markowetz - How to Write
84
e.g. Exempli Gratia
●
Means “for example”
●
And is used like this:
●
●
Some students can hide their intelligence really well, e.g.,
Bob or Carol.
One can easily improve the system, e.g., by adding a
simple counter.
●
Note the use of commas after the abbreviation.
●
Never start a sentence with e.g.
●
IE and EG are often confused. Get them RIGHT.
Jun.Prof. Alexander Markowetz - How to Write
85
Sections and Figures
●
“Section 2” is the name of the second section
●
Thus, it should always be capitalized.
●
●
Next, Section 2 introduces related work.
●
BUT: The next section introduces related work.
And NOT be abbreviated
●
●
And NOT be separated by a line-break
●
●
Next, Sec. 2 introduces related work.
Some words. Next, Section
2 introduces related work. Some more text.
The above equally applies to figures and tables.
Jun.Prof. Alexander Markowetz - How to Write
86
Enumerations (1)
●
You may use bullets or enumerations to list your arguments.
●
For example:
“We address the above challenges through the following
contributions:
- We devise a new powerful algorithm. It outperforms its
competitor by the order of several magnitudes.
- We formally prove its correctness and provide lower as well as
upper bounds for its runtime.
- We experimentally show the tremendous practical benefits of the
proposed approach.
Jun.Prof. Alexander Markowetz - How to Write
87
Enumerations (2)
●
●
Bullets should be short.
If there are more than two short sentences, turn
them into normal paragraphs.
Jun.Prof. Alexander Markowetz - How to Write
88
Enumerations (3)
●
You can use in-line enumerations, to save space
●
Especially inside the abstract
●
●
●
The proposed algorithm is shown to be (i) correct, (ii)
complete, i.e., generate all results, and (iii)
asymptotically optimal.
These bullets can have short subclauses like
(“i.e., generate ...”)
But they must be kept really short
Jun.Prof. Alexander Markowetz - How to Write
89
Enumerations (4)
●
●
●
Or, you can enumerate by starting the sentence
with a number.
We address these challenges through the
following contributions. First, we reduce runtime
by the order of several magnitudes. Second, we
improve robustness. Third, we support datasets
of arbitrary size. Finally, we devise more
informative experiments.
Do NOT use “Firstly”, “Secondly”, etc.
Jun.Prof. Alexander Markowetz - How to Write
90
Typos
●
Are entirely unacceptable
●
Do not rely on a spell-checker
●
You may sue it, but it will not work to well
●
Accept complete responsibility for everything
you write, all the way down to your typos
Jun.Prof. Alexander Markowetz - How to Write
91
Never Copy
●
Not even a single sentence
●
Certainly not from other authors
●
●
Certainly not from Wikipedia
●
●
You will face disciplinary action
You will face disciplinary action
Not from your own papers
●
You will look like a complete idiot
Jun.Prof. Alexander Markowetz - How to Write
92
But Imitate
●
Imitate the style of successful authors
●
Look at how they write
●
Learn common expressions:
●
●
Assume an user trying to find …
●
Thus, we …
●
Hence, the above ....
●
Finally, Figure 8 shows …
But never copy and paste !!!
Jun.Prof. Alexander Markowetz - How to Write
93
Recite
●
When you think you are done: READ the paragraph
OUT LOUD
●
Again
●
And again
●
And again
●
Memorize
●
Fix whatever sounds awkward
●
Grind and polish
Jun.Prof. Alexander Markowetz - How to Write
94
Now we know how to write a paper.
Quickly, two slides on formatting it.
Jun.Prof. Alexander Markowetz - How to Write
95
Page-Numbers
●
Include page-numbers
●
Help the reviewer talk about your paper
●
●
●
The original Latex template may not contain
page-numbers
Find a way to include them
After acceptance, remove page-numbers for the
camera ready version
Jun.Prof. Alexander Markowetz - How to Write
96
Figures, Tables, Equations
●
●
●
●
Should be placed AFTER they are referenced
for the first time
Should not be bunched together, but be equally
spaced between text
Should look neat
Should be readable in black&white as well as
color, as well as on a projector
●
Use dark colors, with a pattern
Jun.Prof. Alexander Markowetz - How to Write
97
Orphans and Widows
Jun.Prof. Alexander Markowetz - How to Write
98
Orphans and Widows
●
●
Remove orphans and widows
●
First Line of a paragraph is last line of a page
●
Last line of a paragraph is first line of a page
By changing the wording
●
●
Insert or remove some words to eliminate the orphan
The other orphan
●
Last lines of paragraphs that consist of a single word
●
Should be eliminated equally
Jun.Prof. Alexander Markowetz - How to Write
99
That's it.
Now you have all the rules.
And one more piece of advice.
Jun.Prof. Alexander Markowetz - How to Write
100
Practice
Like programming,
writing is an art best learned from practice.
Jun.Prof. Alexander Markowetz - How to Write
101
Thank you for your patience.
And now go, write a paper.
Jun.Prof. Alexander Markowetz - How to Write
102
© Copyright 2024