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.
I had the same problem when I did a document for National Cash Register back
What I did was have text in one part of the document. I created an appendix
that had all of the 'artwork' (tables and figures)... This was because so
many of the tables had to be referenced "at the same time"
The document was in a three-ring binder.
When a "user" wanted to read a section of the "text", he/she took the
from the back of the binder and put it in front of himself/herself.
| \ |
| / |
| \ |
| Text / Text |
| \ |
| See / See |
| Fig. 1 \ Fig. 2 |
| / |
| \ |
| / |
This document was used by the software developers, 800-xxx-xxxx support
field service organization, quality assurance team, and a host of others.
They said that for the purpose the document was being used for,
the format and structure "more than met their needs"
I also had list of tables, figures, glossary, and index.
I have been involved in S/W documentation of one form or another since 1970.
Just one person's approach to the 'glorious' world of software
I know what you are going through.
Harry M. Bacheler, Jr.
"The thoughts, ideas, and opinions expressed in my portion of this email
are mine and mine alone. They are not the thoughts, ideas, and/or
opinions of any past, present, or future employers, or any group that I
might belong to."
> -----Original Message-----
> From: bounce-techwr-l-20951 -at- lists -dot- raycomm -dot- com
> [mailto:bounce-techwr-l-20951 -at- lists -dot- raycomm -dot- com]On Behalf Of Carrie
> Sent: Tuesday, 28 March, 2000 02:51 PM
> To: TECHWR-L
> Subject: Placement of tables/figures
> I work for a software company that provides a lot of figures and
> field/description tables in documentation in order to help users complete
> fields on views. Lately, the documentation department has
> debating where to place figures and tables. Some feel that when
> placed within a procedure, tables and graphics are too intrusive.
> Others feel they should be placed within the procedures, next to
> the step they pertain to. Also, many clients have complained that
> they cannot find information about certain fields when
> they are buried in a setup procedure, for example.
> If anyone is facing similar issues or has any recommendations, please
> cmiller -at- mriystem -dot- com <mailto:cmiller -at- mriystem -dot- com>