Transcript Writing with Style - The University of Texas at Austin

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
Focus
Abstract & Introduction
Mechanics
Sentences
Linking Sentences
Emphasis
3
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
Abstract & introduction
Problem statement
Contribution
Result
Meaning
5
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
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
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
Focus
Abstract & Introduction
Mechanics
Sentences
Linking Sentences
Emphasis
9
• Subjects of sentences
name cast of characters
• Verbs name actions involving characters
10
Missing Subjects
“Termination occurred after 23 iterations”
11
Missing Subjects
“Termination occurred after 23 iterations”
“The analysis terminated after 23 iterations”
12
Weak Verbs
“The algorithm supports effective garbage collection in
distributed systems”
13
Weak Verbs
“The algorithm supports effective garbage collection in
distributed systems”
Stronger Verbs
“The algorithm collects garbage effectively in distributed
systems”
14
Verb Nominalization
Verb
discover
move
collaborate
Nominalization
discovery
movement
collaboration
15
Adjective Nominalization
Adjective
difficult
applicable
different
Nominalization
difficulty
applicability
difference
16
empty verb + NOM
“We conducted an investigation of the
tradeoffs.”
17
empty verb + NOM
“We conducted an investigation of the
tradeoffs.”
Verb=Action
“We investigated
the precision and efficiency tradeoffs.”
18
“there is” + NOM
“There is a need for further study of this
analysis”
19
“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
NOM + verb + NOM
“The formation of cycles during alias
analysis prevents further improvements to
this algorithm.”
21
Omit needless nominalization
“Because the alias analysis creates cycles,
we cannot improve it further.”
22
Useful Nominalizations
23
Name an action
“I do not understand
her meaning or
his intention”
(what she means
what he intends)
24
Common concepts
“Taxation without representation was not
the central cause of the revolution”
25
compilation
dependency
inheritance
implementation
26
Noun+Noun+..
Early childhood thought
disorder misdiagnosis often
occurs in state-funded labs.
Noun+Noun+..
Early childhood thought disorder
misdiagnosis often occurs in
state-funded labs.
State-funded labs often
misdiagnosis disordered
thought in young children.
Passive
“The alias analysis was added to gcc.”
29
Passive
“The alias analysis was added to gcc.”
Active voice
“We implemented this analysis in the gcc
compiler.”
30
Concision
• It is imperative to think over in
a punctilious manner each and
every suggestion that is
offered to us.
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.
Focus
Abstract & Introduction
Mechanics
Sentences
Linking Sentences
Emphasis
33
Linking Sentences
subject
• ideas already mentioned
• familiar ideas
verb
• action
object
• new ideas
34
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
Topics form a logical sequence of ideas
old
new
old
new
old
new
old
36
The Point
Intro
Discussion
The point
(best)
…or here
(intro para.)
37
Emphasis
Put important things at the end
sentence
paragraph
section
final words
last sent.
last para.
38
Paper
Containers
Section
• Large-scale
Structure
Paragraph
• Sequence of
items
Sentence
Specific rules
39
Section Titles
First sentence
(or the point)
must include section title
(except the introduction or conclusion)
40
paper
Intro
Discussion
paragraphs
sections
I D
Intro Disc
Intro Disc
paragraphs
paragraphs
I D
I D
I D
sentences
I D
I D
I D I D
I D I D
I D
sentences
41
Thank you for your attention!
Questions?
42
Practicum
43
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