View
357
Download
3
Category
Tags:
Preview:
DESCRIPTION
Citation preview
1
1
Lecture 3Lecture 3Lecture 3Lecture 3
Meshing Words with Images
(Technical Writing CS212)
Abdisalam Issa-Salwe
Taibah University
College of Computer Science & Engineering
Computer Science Department
2
College of Computer Science & Engineering, Taibah University
Design and illustration
� A benefit of using images is end user will have a clear understanding of the information you are presenting.
� Illustration is a really useful tool for taking abstract concepts and turning them into concrete visuals.
2
3
College of Computer Science & Engineering, Taibah University
Table 1. Reactor power levels in Chernobyl accident [Wolfson, 1991].
Date Time Power Level
4/25 1:00 am 3200 MW
4/25 2:00 pm 1600 MW
4/25 11:10 pm 1600 MW
4/26 1:00 am 30 MW
4/26 1:19 am 200 MW
4/26 1:23 am 2,000,000 MW
Two types of illustrations exist: tables and figures
4
College of Computer Science & Engineering, Taibah University
Describing an Illustrative Material
� Illustrative material including photographs, drawings, diagrams, graphs, charts, and maps should be labeled Figure, abbreviated Fig., assigned a number and given a caption.
� Figure numbers can be compound numbers that show both section and sequence number.
� A figure label and caption appear beneath the visual, flush left, with the same one inch margins as the body of the text
3
5
College of Computer Science & Engineering, Taibah University
When presenting numerical data, you choose between tables and graphs
Time(hour)
midnight2:004:006:008:00
10:00noon2:004:006:008:00
10:00
Normal(mg/dl*)
100.393.688.2
100.5138.6102.493.8
132.3103.893.6
127.8109.2
Diabetic(mg/dl)
175.8165.7159.472.1
271.0224.6161.8242.7219.4152.6227.1221.3
Table 2. Blood glucose levels [Carlson, 1982].
* decaliters/milligram
Figure 11. Blood glucose levels for
normal individual and diabetic
[Carlson, 1982].
Hour
12:00 6:00 am 12:00 6:00 pm 12:00
Blood
Glucose
Level
(mg/dl)
300
250
200
150
100
50
0
Breakfast
Lunch Dinner
Normal
Diabetic
6
College of Computer Science & Engineering, Taibah University
Describing Tables
� A table presents data and information
precisely in rows and columns.
� A table is labeled Table, assigned a
number and a caption.
� Place the label and caption above the
table, flush left, and capitalize as a title.
� Place the source of the table and any
notes below the table
4
7
College of Computer Science & Engineering, Taibah University
Temperature(K)
Distance From Burner (mm)
Figure 3. Computational and experimental temperatures for
laminar diffusion flames [Sandia, 1987].
ExperimentSimulation
2000
1500
1000
500
00 2 4 6 8 10
Line graphs are common in engineering and science
8
College of Computer Science & Engineering, Taibah University
Figure 4. Response of T-cells in cosmonauts after short-term and long-term flights [Konstantinova, 1991].
Cells%
Flight Duration (Days)
10
20
30
7-10
112–175211–366
Normal range
Bar graphs compare wholes
5
9
College of Computer Science & Engineering, Taibah University
Describing a Product or Mechanism
� A mechanism is a system of two or more related parts that function together to perform a task.
� Mechanism descriptions are essential parts of technical reports and documents involving specifications and instructions.
� Focus on the physical characteristics of a device and its parts:� size
� shape
� colour
� finish
� texture
� material
� Include figures, diagrams, or photographs to clarify meaning.
10
College of Computer Science & Engineering, Taibah University
Figure 5. Schedule for the construction, evaluation, and production phases of the Solar One Power Plant.
Task 1979 1981 1983 1985 1987 1989
Construction
Test and Evaluation
Power Production
Gantt charts are a type of bar charts
6
11
College of Computer Science & Engineering, Taibah University
Industrial wastes(28%)
Medical and research wastes(16%)
Power reactor wastes(64%)
Power ReactorIndustrialMedicalGovernment
Government wastes(2%)
Figure 5. Volume of low-level nuclear wastes from various
sources [League, 1985].
Pie graphs compare parts of a whole
12
College of Computer Science & Engineering, Taibah University
Figure 6. Estimated annual dose of radiation in the United
States [GPU Nuclear, 1985].
Average dose: 160 mrem
NaturalSources
MedicalSources
85 mrem
70 mrem
{Fallout: < 3mrem
Occupational: < 1mrem
Nuclear power: < 1mrem
Graphs come in many forms
7
13
College of Computer Science & Engineering, Taibah University
When presenting images, you choose between photographs, drawings, and diagrams
Compressor
Combustor
1
2 3
4
Turbine
14
College of Computer Science & Engineering, Taibah University
The main advantage of photographs is realism
Figure 2. Space Shuttle Challenger, from about 59 seconds to 60
seconds into launch (January 28, 1986). On the right rocket, flame first becomes visible and then impinges on tank.
59 seconds
59.5 seconds
60 seconds
8
15
College of Computer Science & Engineering, Taibah University
One advantage of drawings is control of detail
Figure 5. Wind tunnel experiment at Virginia Tech for evaluating film-cooling designs for the blades of gas turbine engines [Thole
and others, 2000].
SecondaryFlow
PrimaryFlow
SecondaryFlow
Turbine Vanes
Combustor Simulator
Dilution Jet
Film-Cooling Holes
16
College of Computer Science & Engineering, Taibah University
The main advantage of a diagram is the ability to show flow of a variable through a system
Figure 8. Schematic of test stand for evaluating components of an air conditioner design.
9
17
College of Computer Science & Engineering, Taibah University
Figure 5. Schematic of thermal
storage system.
RECEIVER
FLASH
TANK
HP
HTR
DEAR-
ATORHOT
WELL
T
S
S
G
TURBINE
TSU
DSPH
TSH
FT
The thermal storage system stores heat in a huge, steel-walled tank. Steam from the solar receiver passes through heat exchangersto heat the thermal oil, which is pumped into the tank. The tank then provides energy to run a steam generator to produce electricity. A schematic of this system is shown in Figure 5.
Scientists and engineers often use illustrationsthat are too complex for the text
18
College of Computer Science & Engineering, Taibah University
The thermal storage system, shown in Figure 6, stores heat in a huge, steel-walled tank. Steam from the solar receiver heats a thermal oil, which is pumped into the tank. The tank then provides energy to run a steam generator to produce electricity.
Figure 6. Schematic of thermal storage system for the solar power plant.
steam
generator
650°F 580°F
425°F435°F
solar
receiver
575°F
425°F
530°F
250°F
ThermalTank
HeatExchanger
HeatExchanger
The precision of the illustrations should reflect the precision of the text
10
19
College of Computer Science & Engineering, Taibah University
Figure 7. Title of figure. Some formats allow you extra sentences to
explain unusual details.
For clarity, you should introduce and explain illustrations in the text
..., as shown in Figure 7.
20
College of Computer Science & Engineering, Taibah University
• The testing hardware of the rocket shown in Figure 8 has five main components: camera, digitizer, computer, I/O interface, and mechanical interface. • Commands are generated by the computer, then passed through the I/O interface to the mechanized interface where the keyboard of the ICU is operated.• The display of the ICU is read with a television camera and then digitized. • This information is then manipulated by the computer to direct the next command.
PRINTERCONTROL
TERMINAL
COMPUTERDIGITIZER
CAMERA
ELECTRO-
MECHANICAL
INTERFACE
ROCKET
Figure 8. Testing hardware.
Inconsistencies between text and images disrupt fluidity
11
21
College of Computer Science & Engineering, Taibah University
Our system for testing the launch controls of the rocket consists of four main parts: computer, electro-mechanical interface, camera, and digitizer. In this system (shown in Figure 9), the computer generates test commands to the rocket through the electro-mechanical interface. The test results are read with a television camera, and then digitized. The computer receives the information from the digitizer, and then directs the next test command.
Figure 9. System to test launch
controls for rocket.
CameraDigitizer
Computer
Electro-
Mechanical
Interface
12
34
Rocket
Illustration is the meshing of words with images
22
College of Computer Science & Engineering, Taibah University
Reference
� Read Finkelstein, Pocket Book of Technical Writing, Chapters 1 to 4.
� Citation for illustrations: Carlson, Gary, “Implantable Insulin Delivery System,” Sandia Technology, vol. 6, no. 2 (June 1982), pp. 12-21.
� Presidential Report on the Space Shuttle Challenger Accident (Washington, DC: US Governmental Printing Office, June 6, 1986), pp. 26-27.
Recommended