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.
Subject:Re: Basic structure question From:bcliver -at- manu -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 16 Oct 2003 07:40:47 -0400
>I'm writing an Admin Guide, and one section is wholly taken up with
creating
>object, and the object creation dialog box appears. In this dialog box,
>there's 13 different property fields to be set...but, explaining each
>property involves major discussion of what it is, whjat it does, how to
>manage it etc (going up to five or six pages worth of description in some
>cases).
I would place the 13 fields with descriptions in a table, regardless of
the length. Admin users like tables.
>So...I'm wondering whether to describe and explain each property
>separetly first before explaining the object creation procedure, or
whether
>to describe and explain each property sequentially as it is displayed in
the
>object creation dialog box, with all the interruptions to the object
>creation procedure that this would involve.
I would provide the concept and procedure first, and if they need help,
refer to the table describing the 13 fields.
Barry Cliver
Lead Technical Writer
Manugistics, Inc.
HAVE YOU SEEN THE LATEST FRAMEMAKER PUBLISHING TOOL?
RoboHelp for FrameMaker is a NEW online publishing tool for FrameMaker that
lets you easily single-source content to online Help, intranet, and Web.
The interface is designed for FrameMaker users, so there is little or no
learning curve and no macro language required! Call 800-718-4407 for
competitive pricing or view a live demo at: http://www.ehelp.com/techwr-l3
---
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.
