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: Lists and Explanations From:Melissa Morgan <mmorgan -at- CDG-HARGRAY -dot- COM> Date:Thu, 29 Apr 1999 11:39:34 -0500
I guess it depends on if you're listing or describing here. If you are just
listing
the document types without descriptions, I would put them with the step. If
you
are describing the document types so that they can make an informed
selection,
I would give a brief overview of the document types (maybe in a table
format), then
add a note explaining, "For more information, see page..." If you need them
to
have ALL the information at this point, but it would be cumbersome between
steps,
I would just refer them straight to the detailed explanations that are
elsewhere.
