RE: Coordinating Field Defs and Procedural Info

["Daniel Frankham" <daniel -dot- frankham -at- saabsystems -dot- com -dot- au>]

For our main documentation project we have a volume dedicated to form
descriptions. ('Form' is the term we use for our software's equivalent
of a dialog box.) In the form reference volume the forms are listed in
alphabetical order. Each form description includes a description of each
field in the form, including the data format and a list of all the
possible values for the field, or a range of possible values for fields
that take numerical input.

In the operating procedures volume, we don't provide much detail on the
use of forms, unless they're especially tricky or unintuitive. We tend
to assume that the interface is fairly self-explanatory with regard to
how forms work, so only a few need a detailed walk-through.

The customer gets these manuals as printed books. Converting the manual
to a soft version with hyper-links is an idea that has been discussed a
few times and may happen some day.

-- 
Daniel Frankham

-----Original Message-----
From: Hickling, Lisa (TOR) [mailto:lhickling -at- Express-Scripts -dot- com] 
Sent: Tuesday, 7 November 2006 1:56 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Coordinating Field Defs and Procedural Info

Tech Scribes! I just gotta know what you think...what is your preference
for coordinating field definitions and procedures in user docs?


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l

Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot- 

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot-  Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.