RE: Documenting field descriptions in printed documentation

Subject: RE: Documenting field descriptions in printed documentation
From: "Grant, Christopher" <CGrant -at- glhec -dot- org>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 17 Sep 2002 14:02:28 -0500


> Are any of these preferred or standard, and if so, which one?
> If not, does anyone have any suggestions as to a good solution for this?

Like Tom Murrell said, just pick a style and agree collectively to stick to
it.

For what it's worth, at my workplace we use option #1 and #2. If there are
more than "a few" fields, we say, "Fill the following fields:" and then we
use a table, listing the field and providing a description of what ought to
go in the field. This is one step in a stepwise process.

If there are only a few (or one) field(s), we'll say, "Type the client's
name Name in the field."

Chris Grant



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Experience RoboHelp X3! This new RoboHelp release combines single sourcing,
print-quality documentation, conditional text and much more, into the most
monumental release of RoboHelp ever! http://www.ehelp.com/techwr-l

Absolutely FREE! FrameMaker/Win 6 & 7 Express Customization (v3):
Quick-access buttons & keys to common functions, char tag/font drop-down
lists, charset browser, QRef guides & much more: http://www.microtype.com/2

---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.



Previous by Author: RE: Documentation problem
Next by Author: RE: Documenting field descriptions in printed documentation
Previous by Thread: RE: Documenting field descriptions in printed documentation
Next by Thread: RE: Documenting field descriptions in printed documentation


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


Sponsored Ads