Technical writing

advertisement
Technical writing
Motivation
A high school student seeks an internship with Civil
Solutions Inc., which is managed by vice president
Richard Rehmann.
The student walks into the office of Civil Solutions
and says,
“Where’s Rich?”
Could the student have improved his communication?
How?
Rhetorical factors
The student did not consider the factors important in
communication:
1. Purpose
What do you want?
2. Audience
What information does the reader need?
3. Context
What is the history? The future?
4. Content
Is the content appropriate? Accurate?
Purpose
What are some possible purposes? Give examples of each.
Audience
What are some considerations regarding audience?
Context
Considerations regarding context:
•
•
•
•
•
•
•
•
•
•
Need for the document
Possible results from the document
Budget
Timeline
Familiarity with audience
Audience expectations
Health of the relationship with the audience
Nature of the subject matter, potential controversy
Range of purposes of the readers
Audience preferences for verbal or visual descriptions
Content
Is the content appropriate? Did you
•
•
•
•
motivate the document sufficiently?
provide just enough background?
explain what you will do?
provide good visuals?
Is the content accurate? Did you
•
•
•
•
check calculations?
cite authoritative sources?
separate observation from speculation?
avoid unwarranted claims?
Example: NIWR proposal
…
Proposal topic: Chicago River
Proposal topic: Chicago River
3 m3/s
91 m3/s
Proposal topic: Chicago River
Flow
Proposal topic: Chicago River
[cm/s] (cm/s)
EastwardVeast
velocity
-4
-3
-2
-1
0
1
2
0
1
From LM
(m)
Depth
Depth [m]
2
3
To LM
4
5
6
7
Uplooker
ADCP
3
4
5
Proposal topic: Chicago River
Density
(kg/m3)
Density (kg/m )
3
1000
0.0
1000.2
1000.4
1000.6
1000.8
1001
1001.2
1001.4
Columbus Drive Bridge Center Line 8:03:00
Columbus Drive Bridge Center line 11:58:00
Depth
Depth (ft) (ft)
5.0
10.0
15.0
20.0
25.0
Proposal topic: Chicago River
Dense water
Light water
Proposal: rhetorical factors
1. Purpose
What is my purpose?
Proposal: rhetorical factors
2. Audience
What do we know about the audience?
Proposal: rhetorical factors
3. Context
•
Need:
•
Possible results:
•
Budget:
•
Timeline:
•
Familiarity:
•
Expectations:
•
Relationship health:
•
Controversy:
•
Verbal/visual:
Proposal: rhetorical factors
4. Content
What do you need in general for a proposal?
What specific content should be included?
Download