RE: Style conventions: Pipelines vs. Arrows, Single step style vs . Sentence.

Subject: RE: Style conventions: Pipelines vs. Arrows, Single step style vs . Sentence.
From: Jon Konrath <Jon -at- datasynapse -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 12 Aug 2002 10:59:45 -0400



On File|Save versus File>Save, I'd agree that you should write these out,
like "On the File menu, click Save." Writing it with pipelines or arrows
makes it look more like ancient ASCII documentation to a forgotten DOS text
editor or something.

FWIW, The second edition of the Microsoft Manual of Style for Technical
Publications covers this on page 174. Any starting docs group needs a copy
of this like an Irish bar needs a copy of the Guinness book of World
Records. I'm not saying you should follow it religiously, but it will help
you solve many arguments down the road.

-Jon

---
Jon Konrath, Technical Writer
DataSynapse, Inc.
jon -at- datasynapse -dot- com
View the DataSynapse email disclaimer here:
<http://www.datasynapse.com/legal/emailprivacy.jsp>

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Want to support TECHWR-L? Get shirts, bags, hats, clocks,
and more from the TECHWR-L Store. All proceeds support TECHWR-L.
http://www.cafepress.com/cp/store/store.aspx?storeid=techwhirl

Save up to 50% with RoboHelp Deluxe. Get 2 great products for 1 low price!
You'll get RoboHelp Office PLUS RoboDemo, the software demonstration tool
that everyone's been talking about. Check it out and save!
http://www.ehelp.com/techwr-l

---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.



Previous by Author: Re: About proprietary writing samples
Next by Author: RE: MS Word--Page Breaks
Previous by Thread: RE: Style conventions: Pipelines vs. Arrows, Single step style vs . Sentence.
Next by Thread: Style conventions: pipelines vs. arrows, single step style vs. se ntence? (take II)


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads