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.
New question concerning table design -- heading labels to be precise.
The document:
I am working on a reference document. In one section, each screen capture of
the GUI is on the left page. Each element is numbered. On the facing page, I
have placed a description of the screen and its purpose. Underneath the
description, there is a table. The column headings are number, element name,
description and "Does this..." The number is the number on the facing page;
the element name is button, menu bar, screen name, etc.; description is a
generally the specific name; and the "Does this..." is a states exactly what
the button does and where it goes.
The audience:
Ordinary, non-technical types.
The issue:
Is the "Does this..." too informal?
What do you think?
How informal or formal do we have to be? What kind of guidelines do you use
personally?
Thanks again for the benefit of your thousand years of experience!
