Writing with Style

1
On Writing Well
Kathryn McKinley The University of Texas at
Austin based on Style Toward Clarity and Grace
by Joseph Williams slides by William Cook
Richard Gabriel
1
2
(No Transcript)
3
Focus
Abstract Introduction Mechanics Sentences Linki
ng Sentences Emphasis
3
4
Abstract introduction
Contribution Result This paper introduces a new
pointer alias analysis that provides control-flow
and context sensitivity. We show that it is one
hundred times faster than the prior state of the
art.
4
5
Abstract introduction
Problem statement Contribution Result Meaning
5
6
Is this abstract better? Why?
Precise flow and context sensitive pointer
analysis is currently limited to programs with
100,000 or fewer lines of code. Pointer
analysis clients, such as verification and
testing, are consequently limited to small
programs because they need high precision. This
paper introduces a new pointer alias analysis
that provides control-flow and context
sensitivity. We show that it is one hundred
times faster than prior algorithms and can
analyze programs up to 1 million lines of code.
Future work should investigate its effects on the
precision and scalability of client analysis.
6
7
Is this abstract better? Why?
More Precise
Precise flow and context sensitive pointer
analysis is currently limited to programs with
100,000 or fewer lines of code. Pointer
analysis clients, such as verification and
testing, are consequently limited to small
programs because they need high precision. This
paper introduces a new pointer alias analysis
that provides control-flow and context
sensitivity. We show that it is one hundred
times faster than prior algorithms and can
analyze programs up to 1 million lines of code.
Future work should investigate its effects on the
precision and scalability of client analysis.
7
8
What could be improved?
Precise flow and context sensitive pointer
analysis is currently limited to programs with
100,000 or fewer lines of code. Pointer
analysis clients, such as verification and
testing, are consequently limited to small
programs because they need high precision. This
paper introduces a new pointer alias analysis
that provides control-flow and context
sensitivity. We show that it is one hundred
times faster than prior algorithms and can
analyze programs up to 1 million lines of code.
Future work should investigate its effects on the
precision and scalability of client analysis.
8
9
Focus
Abstract Introduction Mechanics Sentences Linki
ng Sentences Emphasis
9
10

• Subjects of sentencesname cast of characters
• Verbs name actions involving characters

10
11
Missing Subjects
Termination occurred after 23 iterations
11
12
Missing Subjects
Termination occurred after 23 iterations The
analysis terminated after 23 iterations
12
13
Weak Verbs
The algorithm supports effective garbage
collection in distributed systems
13
14
Weak Verbs
The algorithm supports effective garbage
collection in distributed systems
Stronger Verbs The algorithm collects garbage
effectively in distributed systems
14
15
Verb Nominalization
15
16
Adjective Nominalization
16
17
empty verb NOM
We conducted an investigation of the tradeoffs.
17
18
empty verb NOM
We conducted an investigation of the tradeoffs.
VerbAction We investigated the precision and
efficiency tradeoffs.
18
19
there is NOM
There is a need for further study of this
analysis
19
20
there is NOM
There is a need for further study of this
analysis
Name the actor Researchers should study this
analysis further in the context of its clients.
20
21
NOM verb NOM
The formation of cycles during alias analysis
prevents further improvements to this algorithm.
21
22
Omit needless nominalization
Because the alias analysis creates cycles, we
cannot improve it further.
22
23
Useful Nominalizations
23
24
Name an action
I do not understand her meaning or his
intention (what she meanswhat he intends)?
24
25
Common concepts
Taxation without representation was not the
central cause of the revolution
25
26
compilation dependency inheritance implementation
26
27
NounNoun..

• Early childhood thought disorder misdiagnosis
  often occurs in state-funded labs.

28
NounNoun..

• Early childhood thought disorder misdiagnosis
  often occurs in state-funded labs.

State-funded labs often misdiagnosis disordered
thought in young children.
29
Passive
The alias analysis was added to gcc.
29
30
Passive
The alias analysis was added to gcc.
Active voice We implemented this analysis in
the gcc compiler.
30
31
Concision

• It is imperative to think over in a punctilious
  manner each and every suggestion that is offered
  to us.

32
Concision

• It is imperative to think over in a punctilious
  manner each and every suggestion that is offered
  to us.

• We must consider each suggestion carefully.

33
Focus
Abstract Introduction Mechanics Sentences Linki
ng Sentences Emphasis
33
34
Linking Sentences
34
35
Linking Sentences
Precise flow and context sensitive pointer
analysis is currently limited to programs with
100,000 or fewer lines of code. Pointer
analysis clients, such as verification and
testing, are consequently limited to small
programs because they need high precision. This
paper introduces a new pointer alias analysis
that provides control-flow and context
sensitivity. We show that it is one hundred
times faster than prior algorithms and can
analyze programs up to 1 million lines of code.
Future work should investigate its effects on the
precision and scalability of client analysis.
35
36

• Topics form a logical sequence of ideas

old new
old new
old new
old new
37
The Point
The point (best)?
or here (intro para.)?
37
38
Emphasis
Put important things at the end
38
39
Paper
Section
Paragraph
Sentence
39
40
Section Titles
First sentence (or the point) must include
section title (except the introduction or
conclusion)
40
41
paper
paragraphs
sections
paragraphs
paragraphs
sentences
sentences
41
42
Thank you for your attention!

Questions?
42
43
Practicum

43
44
Improving an Abstract

• Read it
• Interview the writer understand the
• Problem statement
• Contribution
• Result
• Meaning
• Top down sentence improvements
• Subject-action-object
• Link to next sentence

44