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 recommend pretty much always placing figures and tables adjacent to the
step or text to which they apply. Consider using table and figure numbers
and creating a list of tables and a list of figures to augment the table of
contents. This should help your readers find things. Also, consider
expanding your index. If your readers want to be able to search for specific
field information, make sure your index includes markers to that
information. Thus, the reader could scan the index for the field about which
they want information and go directly to the relevant page from the index.
Best regards,
Sean
sean -at- quodata -dot- com
> -----Original Message-----
> From: Carrie Miller [SMTP:CMiller -at- mrisystem -dot- com]
>
> 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.
