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: Online Help question From:Scott Miller <smiller -at- PORTAL -dot- COM> Date:Thu, 29 Oct 1998 09:24:48 -0800
Sounds like you're creating online documentation, not online help. Online
help topics are typically small enough that there is only one figure or
table in a topic, so captions aren't necessary. So, if you have a topic
called "Keyboard Shortcuts" that includes a table of keyboard shortcuts, the
topic title serves as the table caption. Also, there usually aren't very
many figures in online help, so no need for figure captions.
At any rate, if you use figure or table captions in any online media, put
them above the figure or table. You do this because you scroll down to see
the figure or table, and if the caption is below the figure or table, you
can't see the caption until you scroll past the figure or table.
- Scott Miller
smiller -at- portal -dot- com
----------------------------------------------------------------------
> I'm developing an online help system taken as a direct (or almost
> direct) copy of our hardcopy documentation. My question: is it
> customary to include captions for online documentation as you do
> in hardcopy for tables and graphics? Thanks!
>
