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

Subject: Style conventions: Pipelines vs. Arrows, Single step style vs. Sentence.
From: "Colleen" <cpcarey -at- hotmail -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Sat, 10 Aug 2002 10:10:04 -0600


Hello,

My tech writing department is new to the company. We are trying to establish
some style conventions. Two things have come up that my manager (the other
person in the department) and I completely disagree about. One, do you use:

File|Save
or
File>Save

And two, when you have a single step, do you place it in a list all by
itself to set it apart from the introductory information, or do you include
it with the introductory information in one sentence?

To send the information to a port:
a.. Click Send.
or

To send the information to a port, click send.

I should mention that most of the information in the documentation have lots
of steps, so it's not an issue there.

I was also wondering if these were regional preferences, as I learned
technical writing in NY, and she in California. I use the pipeline and
single sentence.

Thank you!

Colleen Carey


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

TECHWR-L is supported by ads and sponsorships...and donations.
You can help maintain the TECHWR-L community with donations
at http://www.raycomm.com/techwhirl/abouttechwhirl/donate.html

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


Follow-Ups:

Previous by Author: Re: Looking for the name of a key on the keyboard
Next by Author: HELP: Dreamweaver, Deva, and CMS
Previous by Thread: FW: Jobs, Statehood, and Opinions Better Left Said
Next by Thread: Re: Style conventions: Pipelines vs. Arrows, Single step style vs. Sentence.


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

Sponsored Ads


Sponsored Ads