Word or phrase |
Definition |
|
|
Additional
material |
This is material that accompanies a technical publication, or keeps it contained.
It might include:
- binders
- covers
- envelopes
- inserts
- reply cards
- tear-offs
|
Audio |
This is sound that is included in a multimedia
application. It might include:
- alerts
- animation sounds
- announcements
- music
- vocals
|
Body text |
This is text contained in the main body of a technical publication.
It might include:
- description
- instructions
- narrative
- prefaces
|
Client |
This is a person, department, or organisation
that commissions work. It is generally accepted that a client represents
the interests of the users, unless otherwise specified. A client might be
from within a technical communicator's own organisation or from another
organisation, and is therefore:
|
Components of the technical publication |
These are the main parts or sections of a technical publication. They might include:
|
Content |
This is the essence of the technical publication. It should include:
|
Designs |
These cover all aspects of a technical publication, and particularly
the components of the technical publication. It might include:
|
Display text |
This is text that assists
the readability of a technical publication (whatever its output media). It might include:
- banners
- footers
- headers
- labels
- links
- titles
|
Error |
An error could be due to editorial or printing
mistakes. Errors might include:
- added component
- inconsistencies
- missing components
- spelling
- typographical
- wrong components
- wrong version
- wrongly-positioned components
|
Graphics |
These are visual elements that are contained
in a technical publication. They might
include:
- banners
- diagrams
- drawings
- logos
- plans
|
Information |
This is used throughout the standards to
cover all types of information used within a technical publication or to actually assist
the production of it. It might include:
|
Information
systems |
These are systems that record and store information, including a technical publication itself and information
relating to its publication. They might include the use of:
|
Instructions
and guidance |
These are parts of a technical publication that are designed
to help the user navigate through it. They might
include:
- contents
- glossaries
- help files
- indexes
- introductions
- references
|
Methods
for creating the page layout |
These are the principal ways in which pages can be designed. They might include the use of:
|
Multimedia
components |
These are components used primarily in
computer-based interactive publications. They might include:
|
Output media |
This is the form in which a technical publication is distributed to users. It might include:
- CD-Rom (or equivalent)
- computer hard storage (floppy disk or equivalent)
- on-line (intranet or internet)
- other transmission methods (eg phone help lines)
- paper
|
Page |
This is the main method for displaying page components. They might include the use
of:
- electronic display on a screen
- sheet of paper
|
Page components |
These are components that appear on a page. They might include:
|
People |
A generic word that covers:
- clients
- colleagues
- specialists
- suppliers
|
Production
methods |
These are the methods for actually producing
a technical publication. A publication
might be provided in paper format, but is actually produced electronically.
This could happen in reverse, with a technical drawing being produced
by hand, and then scanned into a computer to be delivered on-line. Methods
therefore might include the use of:
|
Research methods |
These cover any activity designed to elicit information on products and services. They might
include:
- dismantling products
- interviews
- observation
- questionnaires
|
Resources |
Resources are used in the production of
a technical publication. They might include:
- equipment
- facilities
- finance
- materials
- people
- time
|
Revision |
These are actions to improve something,
and might include:
- adding
- removing
- replacing
|
Structure |
A technical
publication has a structure, both overall and on each of the pages.
The structure determines how the user can navigate through the technical
publication, and:
- determines which components are necessary
- the role of the components
- relationship of components to each other
- sequence of components
|
Style |
A technical
publication has a style, both overall and on each of the pages. It might include:
- colour
- dimensions
- texture
- typography
|
Supplementary component |
This is material that is added to a technical publication. It might include:
|
Technical
publication |
This is the main focus of the work. Technical
publications are produced for every industry and for a wide range of
purposes. Some of the more usual forms might include:
- handbooks
- instruction manuals
- maintenance manuals
- user guides
|
Text |
Text is key to almost all technical publications, and comes in two primary forms:
|
Translation |
This refers to the processing of words
and syntax, and might include:
- controlled English
- foreign language
|
Users |
These are the people
who actually use a technical publication
for the purpose for which it is designed. They might include:
- clients
- customers of clients
- others
|
| Vocabulary |
It is important to have an idea of the way a technical publication will be read
or used by users. The vocabulary is aimed at a
particular type of user, and is a coherent collection of:
|