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: Grammar Question: Ensure or Make From:Rose Wilcox <RWILC -at- FAST -dot- DOT -dot- STATE -dot- AZ -dot- US> Date:Fri, 27 Oct 1995 13:44:00 PDT
Bill writes:
>Hi!
Hi, yourself! :-)
[snip]
>Should I use:
>"Make sure that you are off-line prior to selecting this option."
>OR
>"Ensure that you are off-line prior to selecting this option."
I don't think it makes much difference. Pick the one you like the best. I
like "make sure" the best; in my opinion, it sounds less stuffy... BUT
*definitely* say "before" instead of "prior to".
The usual ensure battle is between insure, ensure, and assure. All three
words mean the same thing, but they have different connotations.
>Also, is there such a thing as a writing style that must be used whenever
>Windows PC software products are being documented? This developer claims
>that this Windows PC software product writing style is MUCH different than
the
>writing style I'm supposed to use when documenting an IBM Mainframe product
>or even a Macintosh software product.
Nothing in this world *must* be done, grasshopper. (Sorry I was just
teasing one of our writers here by calling her grasshopper, now it's gone
and stuck....)
There are different style guides from IBM, MS, and Apple. Sometimes
different diggie-boppers on the screen-thingies are called specific names by
these companies. Sometimes sticking to those names can be helpful, and
sometimes using those specific names can be confusing to the reader, since
they can be real "techie". The controversy over what to call a window and
what to call a dialog box rages on, for instance. So for now, it's
writer's discretion.
Other than names for windows, dialog boxes, and other screen elements, style
is style is style.
Being consistent with yourself and knowing your audience are the two
hallmarks of quality in these cases. Do your research and stick to your
guns with those developers. It's good that they care about the
documentation, though I'm sure it's difficult fending off these feuding
opinions. Remember, the ultimate decision must rest with the tech doc
team, guided by the principles of good writing within the limitations of the
specific business needs.
Rose A. Wilcox
rwilc -at- fast -dot- dot -dot- state -dot- az -dot- us
ncrowe -at- primenet -dot- com
"...There's never only _one_ explanation," said the rather small
gentleman. "It depends on which one you want to believe! _I_ believe in
believing six impossible things before breakfast, myself." -- Edward Eager,
_Half Magic_
