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.
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.
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.