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: Perform vs. do From:"Barb" <caslon -at- windstream -dot- net> To:"'Chris Despopoulos'" <despopoulos_chriss -at- yahoo -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Sun, 13 Oct 2013 10:08:06 -0400
We can consider changing the construct when we move to a new tool and format
next year. However, there are at five years of docs done by at least eight
writers in this format, with large amounts of reuse (we use Author-it), so
it's not something we can do easily. Also consider that we are short-staffed
by 2 people at the moment.
So for right now, we're taking the baby step of getting standardized on
"perform" vs. "do." I ordered the ASD-STE100 to see what they have to say.
Barb
-----Original Message-----
From: techwr-l-bounces+caslon=windstream -dot- net -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+caslon=windstream -dot- net -at- lists -dot- techwr-l -dot- com] On Behalf
Of Chris Despopoulos
Sent: Sunday, October 13, 2013 4:06 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: Perform vs. do
Ok, I'm coming into this late, and I tried to look at these examples, but it
requires that I register to do so. Anyway, my question is, can't you get
rid of the entire "Perform/Do" construct? Why not just say...
To foo the bar:
1. Baz the bongo
2. Bip the bingo
3...
This puts the purpose of the procedure at the head of the steps, reduces
syllables, and gets rid of the problem.
I agree that "Do the following steps" sounds terrible. It sounds like
teenager speak. I'm sure there's a level of analysis concerning mass nouns
in the subject or object or some such that could explain why it's awkward,
but I'm not the one to ferret it out!
cud
>
> If you are a true glutton for punishment, you can download the
> Reference Manual and see the examples in context.
>
>http://www.keithley.com/data?asset=57633
>
> The autozero example is on page 136.
>
> The User's Manual is the one that tends to use the ".... perform the
> following steps" format:
>http://www.keithley.com/data?asset=57632
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for
authoring.