SECTION IX
Front / End Materials
& Use of Graphics
=====================================================================
Points to cover:
 contents and formatting of front / end materials
 references made to graphics (call-outs)
IX.1
Front Materials
The Cover & Title
 an attractive and yet conservative cover: beware of over using Print Shop or similar
graphics programs which offer ‘cutesy’ artwork. Cutesy artwork implies immaturity and
lack of awareness of professionalism, i.e., the design and graphic culture associated with the
business community.
 presents key information: the title of the manual or the name of the product, the edition,
series, or generation of the product, the author(s), and special information to attract the
reader, such as the intended user or special features of the manual. (See the cover of this
student manual.)
The Title Page
This is the first page after the cover. It presents the title of the manual again, the author(s), the
edition number, and mostly everything that you have put on the cover. In some cases, the
client’s name is also presented here too. For published manuals, it is also the place where the
place and year of publication are stated. (See the title page of this student manual)
IX.2 End Materials
End materials usually include appendices, glossaries and indexes which collect material that
make it easier for the reader to gain full use of the product or the user manual, but which does
not have to be read in sequence.
Appendices
Appendices contain information which does not have to be read in full or in sequence to get full
use of the product. The are for reference, and can include specifications, diagrams, tables of
characters, tables of error messages, quick trouble-shooting guides (mainly found in reference
manuals) schematics, and extra ’nice to have’ information , such as creating batch files for
loading, and so on. Appendices, like their major chapter counterparts, are also numbered, titled
and paginated.
The Glossary
The Glossary of a document is a mini-dictionary of terms mentioned in the document.
Explanations given in glossaries sometimes summarize extended definitions found in major
chapters or extend the brief definitions given in major chapters.
The Index
IX-1
The Index contains a list of all the key words or terms which a reader might wish to consult.
Indexes are seldom found in tutorial manuals (See Section II.3 for differentiation between
reference and tutorial manuals).
IX.3 References made to graphics
 Present graphics effectively.
 Present graphics where they can supplement or complement your text.
 Don’t supply graphics which simply repeat the information give in text or vice versa.
 Some rules to consider:
1.
Place visuals as close as possible following the text reference. If a
visual in a book requires an entire page, you should try to locate it
on the page facing the text reference and discussion. If a visual in a
report (printed only on one side of the paper) requires an entire
page, the visual should be located on the page following the text
reference. Visuals that readers need to refer to repeatedly can be
placed near the end of the document. For example, they can be
located after the final text reference or in the first appendix on a
fold-out page, as shown in Figure 10.3.
2.
Accurately label each visual. Make sure to include complete
identification, title and caption.
Example
Table 1: Worker Fatigue Using Wire Cutters (# + caption)
Worker fatigue was compared using three different models of
ergonomic cutters during a two-week period. (brief, essential
commentary)
3.
Include complete dimensions of objects in each visual. Specify the
units of measure or scale.
4.
Whenever possible, spell out words rather than using abbreviations.
If abbreviations are included, use standard ones and include a key.
5.
Surround the visual with white space to separate it from the text of
the document.
6.
Include a complete textual reference. Do not assume that readers
will check a visual unless you refer to it. Your reference should
include the number and title. Textual references can be
accomplished in several ways:



…as illustrated in Figure 2.
…(see Table 3).
The effectiveness of the antitoxins tested is presented in Figure
4.
IX-2

Table 5 shows the rapid increase of gas prices during a fiveyear period.
7.
If a document has more than five visuals, include a List of Figures
or List of Tables at the beginning of the document.
8.
Identify the source of the data as well as the graphic designer.
9.
Specify the focus or interpretation you want readers to apply when
examining a visual. Without a sentence to identify the significance
of a visual, readers may not understand its purpose.
IX-3
EN 3164
ASSESSMENT FORM
Assignment #3
Final version of group manual
Group work assessment
Students: ___________________________________
title
preface
poor
glossary
table of contents
formatting
cover + title page
practice tasks
consistency in writing style
overall continuity
unclear
poor
average
poor
passed
Group Grade: ___________
average
creative
transparent & focused
average
good
excellent
consistent in writing style
average
effective strategies
well-formatted
clearly written
page supplied
poor
passed
average
poor
average
oranization
poor
passed
average
good
excellent
poor
passed
average
good
excellent
poor
passed
average
good
excellent
Other comments
IX-4
good
title supplied
excellent
design
Individual Assessment
Student: __________________________
Contents
motivation in introductory texts
orientation in introductory texts
explanation of terms where applicable
announcement of beginning of steps
clarity of steps
notes, warnings, cautions given clearly
accuracy in steps
supply of graphics
supply of responses
supply of purposes of actions
headings
sectioning
Language
syntax accuracy at word level (e.g., articles,
prepositions, etc.)
syntax accuracy at sentence level (e.g.,
sentence structure, etc.)
conciseness
preciseness
style in general
Grade: _____________
poor
passed
average
good
excellent
poor
passed
average
good
excellent
poor
passed
average
quite effective
very effective
no
yes
poor
passed
average
good
excellent
poor
passed
average
good
excellent
poor
passed
average
good
excellent
poor
passed
average
good
under-supplied
over-supplied
no
excellent
good
yes
poor
passed
average
good
excellent
poor
passed
average
good
excellent
poor
passed
average
good
excellent
poor
passed
average
good
excellent
poor
passed
average
good
excellent
poor
passed
average
good
excellent
poor
passed
average
good
excellent
Other comments:
IX-5