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: Phrasing recommendations From:Robert Heath <robert -dot- heath -at- FRITZ -dot- COM> Date:Fri, 21 May 1999 09:36:26 -0700
-----Original Message-----
From: lerickso -at- MQSOFTWARE -dot- COM [mailto:lerickso -at- MQSOFTWARE -dot- COM]
Sent: Friday, May 21, 1999 8:22 AM
To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
Subject: Phrasing recommendations
I searched the books I own and the list archives and did not find any
information about phrasing recommendations and I hope the list can help.
Currently the manual reads, "We recommend that you do not change the user
name and leave the default." The "We recommend" part is where I shudder
(and struggle). I do not want to say "It is recommended..." either.
How should I phrase a recommendation for installation or a setting within a
software program? Any suggestions?
-Lief Erickson
MQSoftware, Inc.
lerickson -at- mqsoftware -dot- com
I do not know whether the template you're using allows for this sort of
thing, but you could use an indented note with a note icon next to it (or
even a warning icon), the text saying something like this: "Changing the
default user settings may result in (whatever sticky situation may arise)."
The recommendation would then be implied.
Robert
*****************
Robert Heath
Technical Writer
Fritz Companies, Inc.
San Francisco, CA
