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:Re: Figures - Captions and References? From:Kathy Das Gupta <kdasgupt -at- NOTES -dot- CC -dot- BELLCORE -dot- COM> Date:Wed, 6 Jan 1999 12:56:36 -0500
<snip>Should all figures in a document have captions and if they do, should
all figures in
that document have references? I was taught, and through experience, that
figures should have captions and references. I am writing a user's guide
and am beginning to question that philosophy. </snip>
In my experience, yes, they are necessary. Figures need captions because
two figures (such as 2 screen shots) may appear very similar, but have a
significant difference. The caption will easily draw attention to the
distinction. For example, two captures may be exactly the seem EXCEPT for
the data in one field. The data in that field may significantly affect the
rest of the workflow. The caption can point out the difference.
I always include a table of figures, including the caption text, so a
reader/user can glance at the table to find what s/he is looking for, in
addition to using the TOC and/or index.
Keep in mind that my experience is based solely on documenting software.
Different types of documentation likely has different needs.
Kathy Das Gupta
Tech Writing Consultant
Currently Posted at Bellcore
