Re: Too many tables in documentation

Subject: Re: Too many tables in documentation
From: "Wayne J. Douglass" <wayned -at- VERITY -dot- COM>
Date: Thu, 30 Jan 1997 10:20:23 -0800

At 12:22 PM 1/30/97 -0400, Heidi Margenau wrote:
>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
>
So, what's the problem? Either you use tables or you don't.

--Wayne Douglass

=========================================================
Verity, Inc. Email: wayned -at- verity -dot- com
894 Ross Drive Telephone: 408-542-2139
Sunnyvale, CA 94089 Facsimile: 408-542-2040
Connecting People with Information: http://www.verity.com
=========================================================

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: Re: "Good" Web Pages
Next by Author: Re: Intuitive (was Minimalism)
Previous by Thread: Too many tables in documentation
Next by Thread: Re: Too many tables in documentation


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

Sponsored Ads


Sponsored Ads