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: The project that would not end! From:Michele Marques <mmarques -at- CMS400 -dot- COM> Date:Thu, 20 May 1999 10:08:53 -0400
There might be a quick solution. Is the information in the "Things
You Should Know" tables of special importance in some way (e.g.,
pre-requisites before starting a procedure, hilights of key points,
Although you might not organize the manual in such a matter, if
there is a consistent reason why the information appears together
in the table (even if a loose one, such as hilighting key points), you
could do a global search and replace on "Things You Should
Know". It might be replaced with "Before You Start", "Key
Features" or "Hilights".
Don't feel you're alone... I'm on a slow mission to convert
thousands of instances of "To Begin" with "Find this Menu" (or
"Find this Option") and rewording the inconsistent explanations of
locating the particular menu or option. Fortunately, slow updates
work for me, as documentation is continually updated to reflect
Technical Writer, CMS Manufacturing Systems
mmarques -at- cms400 -dot- com