Too many tables in documentation

Subject: Too many tables in documentation
From: Heidi Margenau <Heidi_Margenau/USG -at- USGROUP -dot- COM>
Date: Thu, 30 Jan 1997 12:22:46 -0400

Hello everyone

My department has been struggling over the issue of using field and
description plus procedural tables in our documentation.

Here is our problem:

We are documenting a payroll/hr software application which uses many
windows, tabs and pages. Each window (or screen) has to be documented for
paper and online help reasons (we use doc-to-help). To define what's on
each screen, we first have a field and description table and then later in
the section we have a procedural table (step/action) that guides the user
through any action that has to be carried out for that screen. Since our
documentation is somewhat screen driven, it is turning into all tables. We
have looked through all types of different documentation related to our
field, and no one seems to be running into this problem. (Their procedures,
if any, are buried within paragraphs and field/description screens are also
described in paragraph format.)

Any feedback on how to solve this problem, or if you know the current
trends for field/description plus procedural tables within user guides
would be greatly appreciated

TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html


Previous by Author: One document/two pagelayouts
Next by Author: Online Document Revision Practices
Previous by Thread: Re: Editorial or Technical Review
Next by Thread: Re: Too many tables in documentation


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads