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.
You could list the five document types in a table format with a short
explanation for each one. Then link each document type to another part of
the document to provide more detailed information (if necessary).
"Select the document type from the drop-down list. There
are five different document types..."
Brant Bangeman
Technical Writer
Tapscan WorldWide, Inc.
-----Original Message-----
From: Aoidìn Scully [mailto:ascully -at- FLEXICOM -dot- COM]
Sent: Thursday, April 29, 1999 11:10 AM
To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
Subject: lists and explanations
I need to canvass a few opinions, folks.
I'm explaining how to perform a series of steps for a procedure and
have to give more information on a particular point.
For example: "Select the document type from the drop-down list. There
are five different document types..."
So, do you think I should give it after the step in question, or refer
them to another part of the document, where I've given an explanation? I
don't want to break up the sequence of steps, but at the same time, I
don't want them to be looking all over for the explanation.