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:QUERY: awkward paragraph(?) and formatting From:Robin Johnson <robin -at- MACSCH -dot- COM> Date:Thu, 3 Sep 1998 15:24:36 -0700
CROSS POSTED TO TECHWR-L, TECHCOMM-L and COPYEDITING-L
Okay, wordstars. I'm having a bit of a problem and I'm hoping that someone
can offer a little advice. I'm working on an end-user manual for a software
product (target audience=systems administrators and other IS personnel). In
order to use the software, there has to be a licensing or authorization
system--kind of a security measure--in place. The section in the
documentation that deals with this issue begins (names changed to protect
the innocent...or guilty depending on your perspective <g>):
_____
XYZ-PRODUCT requires one of the following authorization methods in order to
operate:
* The name of a network license server
* The pathname of a file containing
ABCD node-locked licenses
* The pathname of a file containing one or more
node-locked authorization codes
This section explains these methods under the following topics respectively:
This construction seems a bit awkward to me, but I can't figure out how to
fix it. I'm also concerned that I've clustered too many bullets in one
area, especially since I've got another bulleted list a little further down
on the page. Is there a way to simplify or reorganize this information?
It's just supposed to be a brief introduction, but I'm tearing my hair out
over it.
TIA
Robin Johnson mailto:robin -dot- johnson -at- macsch -dot- com