Lecture3 (cs212)(wordswith images)

Lecture 3

Meshing Words with
Images
(Technical Writing CS212)

Abdisalam Issa-Salwe
Taibah University
College of Computer Science & Engineering
Computer Science Department

1

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
College of Computer Science & Engineering, Taibah University

1

Two types of illustrations exist: tables and
figures
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

3

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

4

2

When presenting numerical data, you choose
between tables and graphs
Table 2. Blood glucose
300 Breakfast
levels [Carlson, 1982]. Lunch Dinner

250
Time Normal Diabetic
(hour) (mg/dl*) (mg/dl) Diabetic
Blood 200
midnight 100.3 175.8 Glucose
2:00 93.6 165.7
4:00 88.2 159.4 Level
150
6:00 100.5 72.1 (mg/dl)
8:00 138.6 271.0
10:00 102.4 224.6 100
noon 93.8 161.8
2:00 132.3 242.7 Normal
4:00 103.8 219.4 50
6:00 93.6 152.6
8:00 127.8 227.1
10:00 109.2 221.3 0
12:00 6:00 am 12:00 6:00 pm 12:00
* decaliters/milligram Hour

Figure 11. Blood glucose levels for
normal individual and diabetic
[Carlson, 1982].
5

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

6

3

Line graphs are common in
engineering and science
2000

1500

Temperature
(K) 1000

Experiment
500
Simulation

0
0 2 4 6 8 10

Distance From Burner (mm)

Figure 3. Computational and experimental temperatures for
laminar diffusion flames [Sandia, 1987].
7

Bar graphs compare wholes
30

Normal range
20
7-10
Cells%

10 112–175
211–366

Flight Duration (Days)

Figure 4. Response of T-cells in cosmonauts after short-term
and long-term flights [Konstantinova, 1991].
8

4

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.

9

Gantt charts are a type of bar charts

Task 1979 1981 1983 1985 1987 1989

Construction

Test and Evaluation

Power Production

Figure 5. Schedule for the construction, evaluation, and production
phases of the Solar One Power Plant.

10

5

Pie graphs compare parts of a whole
Power Reactor
Medical and research wastes
Industrial
(16%)
Industrial wastes Medical
(28%) Government
Government wastes
(2%)

Power reactor wastes
(64%)

Figure 5. Volume of low-level nuclear wastes from various
sources [League, 1985].

11

Graphs come in many forms

Natural
85 mrem Sources

Medical
70 mrem
Sources
Average dose: 160 mrem

{Fallout: < 3mrem
Occupational: < 1mrem
Nuclear power: < 1mrem

Figure 6. Estimated annual dose of radiation in the United
States [GPU Nuclear, 1985].
12

6

When presenting images, you choose between
photographs, drawings, and diagrams

1 4
Combustor
2 3

Compressor Turbine
13

The main advantage of photographs is realism

60 seconds

59.5 seconds

59 seconds
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.
14

7

One advantage of drawings is control of detail
Combustor Simulator
Turbine Vanes

Secondary
Flow

Dilution Jet
Primary
Flow

Secondary
Flow
Film-Cooling
Holes

Figure 5. Wind tunnel experiment at Virginia Tech for evaluating
film-cooling designs for the blades of gas turbine engines [Thole
and others, 2000]. 15

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. 16

8

Scientists and engineers often use illustrations
that are too complex for the text

The thermal storage system DSPH
RECEIVER
stores heat in a huge, steel- TSU
walled tank. Steam from TSH
FLASH
the solar receiver passes TANK FT
through heat exchangers T
S
to heat the thermal oil, DEAR-
TURBINE S
G
which is pumped into the ATOR
HOT
HP
tank. The tank then HTR
WELL

provides energy to run a
steam generator to
produce electricity. A Figure 5. Schematic of thermal
schematic of this system storage system.
is shown in Figure 5.
17

The precision of the illustrations should
reflect the precision of the text
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.

650°F 580°F
575°F 530°F

solar Heat
Exchanger
Thermal Heat
Exchanger steam
receiver Tank generator

435°F 425°F 425°F 250°F

Figure 6. Schematic of thermal storage system for the solar power plant.
18

9

For clarity, you should introduce and explain
illustrations in the text

..., as shown in Figure 7.

Figure 7. Title of figure. Some formats allow you extra sentences to
explain unusual details.

19

Inconsistencies between text and images disrupt
fluidity
• The testing hardware of the
rocket shown in Figure 8 has five
CONTROL
main components: camera, TERMINAL
PRINTER
digitizer, computer, I/O interface, CAMERA
and mechanical interface.
DIGITIZER COMPUTER
• Commands are generated by the
computer, then passed through
the I/O interface to the
mechanized interface where the ELECTRO-
keyboard of the ICU is operated. ROCKET MECHANICAL
INTERFACE
• The display of the ICU is read
with a television camera and then
digitized. Figure 8. Testing hardware.
• This information is then
manipulated by the computer to
direct the next command. 20

10

Illustration is the meshing of words with images
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.

1 Electro- 2

Computer Mechanical
Interface Rocket

4 3
Digitizer Camera

Figure 9. System to test launch
controls for rocket.
21

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.
22

11

Lecture3 (cs212)(wordswith images)

Recommended

Recommended

More Related Content

Viewers also liked

Viewers also liked (17)

Similar to Lecture3 (cs212)(wordswith images)

Similar to Lecture3 (cs212)(wordswith images) (20)

More from Taibah University, College of Computer Science & Engineering

More from Taibah University, College of Computer Science & Engineering (20)

Lecture3 (cs212)(wordswith images)