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.
Ok, maybe you all can help with a debate I'm having with one of my PMs.
Whenever we need to tell somebody to enter their own specific information
(such as a machine IP address), I would like to put it in brackets. For
example:
"In the text box, enter <the IP address of the primary mail server>, as
illustrated below."
Here's another one:
"In the message body, type:
admin2 <your list name>
subscribe <list member's address>
adminend2"
As it stands now, it reads:
In the message body, type:
admin2 mylist
subscribe address
adminend2
where "mylist" and "address" are in italics.
Whaddaya'all think?
Thanks for all your wonderful input!
Bev Lockhart
Documentation Editor
Seattle Lab, Inc. PHONE: (425) 825-7012
11730-118th Ave. NE FAX: (425) 825-7013
Ste. 400
Kirkland, WA 98034-7120
