TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Follow-Up On Post About Illustrations And Tables From:George Mena <George -dot- Mena -at- esstech -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 1 May 2003 14:29:39 -0700
In response to Diane Gonthier's question about why we distinguish between
tables and illustrations, I thought I'd share this additional information
with everyone here.
The following comes from MIL-STD-38784 references on illustrations and
tables. These references define the differences between the two types of
informational elements used in most, if not all, technical documentation of
any kind:
4.3.9 Tables, Charts And Graphs. Reference data (other than illustrations,
drawings, diagrams) shall be presented in tabular, chart or graph form. Any
other type of data whidh lends itself to
tabular, chart or graph form may also be so presented. Tables, charts and
graphs shall be so designed that they are easily understood. Charts shall be
presented as tables or illustrations,
whichever is most appropriate. Graphs shall be considered illustrations, and
be assigned figure numbers.
4.3.9.1 Tabular Material. When a small amount of tabular information is to
be inserted and will not require referencing from adjacent text, it may be
included within a paragraph of text without
identifying it as a table.
4.5.7 List of Illustrations. Publications containing ten or more
illustrations (including charts and graphs assigned figure numbers) shall
have a list of illustrations showing the figure number, title,
and page number of each figure. This list shall include foldout pages,
schematics, etc. The security classification, if any, of illustration titles
shall be indicated. Layout shall conform to Figure 18
except that a single column format shall be used when the manual is prepared
in single column. Each manual or volume in a set (see 3.2.25 and 3.2.35) of
manuals shall contain its own list of
illustrations. In addition, Volume 1 or the first manual of the set shall
contain a list of illustrations for all volumes or manuals in the set.
4.5.8 List of Tables. Manuals containing ten or more tables (including
charts assigned table numbers) shall have a list of tables showing the table
number, title, and page number of each
table. The security classification, if any, of table titles shall be
indicated. Layout shall conform to Figure 18, except that a single cohunn
format shall be used when the manual is prepared in single
column. Each manual or volume in a set (see 3.2.25 and 3.2.35) of manuals
shall contain its own list of tables. In addition, Volume 1 or the first
manual of the set shall contain a list of tables for
all volumes or manuals in the set. When both are brief, the list of
illustrations and list of tables may be included on the same page.
4.6 Illustrations. Style and techniques shall be of a quality which will
produce artwork that will clearly, adequately, and economically portray the
information to be illustrated. Illustrative
material shall be used to: describe an item or idea if this can be done more
efficiently and effectively by graphic methods; clarify text, present phases
difficult to describe by text alone; call
attention to details; and fbrniah graphic identification of parts and tools.
Multiple sheet, or sequence number illustrations, in addition to
step-by-step operational type, may be used for
depicting disassembly, assembly, removal, installation, etc. Illustrations,
other than foldouts, shall be located as near as possible to the point at
which they are first referenced, except where this
would require unnecessary duplication of illustrations.
Hope this helps.
George Mena
Technical Lead/Sr. Technical Writer
ESS Technology, Inc.
48401 Fremont Blvd.
Fremont, CA USA 94538
510-492-1763
---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
