Tech Editing vs. Grammar?

Question

What would you say is grammar's "use" in technical editing, and would you say that there are problems using grammar for a technical editor? Is grammar as important in a manual (assuming it is readable and usable for the customer) as it is in a business letter? How and why or why not?

Thanks, everyone!

~~Nao

BarbaraPA · Accepted Answer

Hi Nao, and welcome to the forum.

Is this a discussion for a class you're taking? Do you need to write an essay on this? You shoudl share your thoughts too.

I can tell you one thing: I took an editing class, and was bitterly disappointed to find out that it was 90% grammar - and not only that, prescriptivist grammar on things that are now no longer looked down on, like using "their" as a gender-neutral, third-person-singular pronoun.

That doesn't mean that a tech editor doesn't have to know grammar. Good grammar gives credibilty and shows attention to detail. Poor grammar (in a native English speaker) makes me wonder what else your education didn't cover and makes me less likely to trust your other areas of expertise and good grammar shows me you care about your work. If you don't care enough to correct bad grammar, did you care enough to correct coding errors?

Goodman · Answer

<<<What would you say is grammar's "use" in technical editing, and would you say that there are problems using grammar for a technical editor?>>>

Hi Nao,

I am still not very sure of your question concerning "grammar". As to the rest of your post,

Are you interested in the validation or opinion about grammar importance in technical writing?

Without hesitation, grammar is definitely important in formal business writing. Perosnally,

I don’t know if this has to do with the social stigma where people in suits and ties are regarded

as better educated.

As to the technical world, things are more relaxed. Although people in the tech field are just as educated (perhaps even more)

the scruitiny on grammar is more forgiving on tech material in genreal. But I still think grammar should be a critierian in any

presentation of written material. Bu that's one man's opinion...

Naomijameston · Answer

Yes, this is for a class I'm taking (technical editing-focused). Personally, I love grammar and because of that, I am enjoying the class greatly. However, I'm not sure where to go for more information on the use of grammar in technical documents. My teacher brought up the point that if the document works the way it is meant to (you can easily set up the TV stand you just bought instead of calling customer support), grammar isn't necessarily important. I argued that the sentence can be completely changed if even one comma is out of place, especially in a list (I'm a HUGE fan of commas, incidentally).

I'm not asking which of us is right, but I am trying to feel out people's opinions and thoughts on the subject. Our paper is an informative piece about the importance of having a knowledge of grammar in technical editing, if that helps at all.

~~Nao

P.S. Thanks for the welcome! I think I'm going to enjoy it here.

BarbaraPA · Answer

And in business communications, if I wrote "U ask me Thursday 4 the file. The files is attachted for you're review and approval" would that not also be equally clear what is meant? Is there any doubt about the meaning? No.

What does it do to my credibility? What does it show about my work ethic? Attention to detail is attention to detail.

Naomijameston · Answer

Reading that made me twitch; I can't imagine trying to write that! Unfortunately, that is how some people write nowadays (wow, I'm making myself sound old, aren't I?), even in a business environment. My husband has printed out and brought home several memos sent company-wide from his regional boss, and every sentence is written more or less like your example. I was absolutely speechless and yes, didn't believe in his credibility as a manager anymore.

However, is a television manual said "insret red plug in2 TV," I could still get the installation done easily. (Yes, I had a hard time writing that- maybe I'm a bit too sensitive?) I wouldn't trust the company as much anymore, but my television would work.

~~Nao

Goodman · Answer

Now I see what your question is. That's exactly the kindof writing I do on my job. Instructional and precedural writing are less stringent in terms of grammar but it doesn't mean it's "non-essential". To me, grammar is the backbone of any writing. Without it, the content can't flow nicely, technical or otherwise. Furthermore, incorrect grammar may lead to confusion and or misunderstanding.

If I were to write a simple troubleshooting procedure for a "no power" problem on a TV set, This is what I would say:

1) Check that the wall outlet is energized by plugging a known good appliance, i.e. table lamp, into the outlet, if a volt
meter is not available. With a volt meter, switch the dial to AC setting, then insert the black and red leads into the left
and right receptical of the outlet, it should read 115-120 volts if the powe is present. If this is validated, continue with the
rest of the procedure.

2) Unplug the TV. Turn the TV around and locate the fuse holder.

3) Remove the fuse by inserting a non-metalic object, such as a plastic ballpoint pen, behind the fuse.
Lift the fuse from the metalic clips and then pull it out from the fuse holder.

4) If no volt meter is available, check for any sign of burn mark on the fuse and if the filament is opened. If the fuse is good.
the problem may be inside the TV set, in which case, do not attpempt to open the back panel for repair. Contact qualified TV repair technician.

5) If the fuse is blown, replace the fuse with identical amperage and connect the TV to the electrical outlet again.

6) If the problem persists, contact a qualified technician for repair.

Is this close to your question?

Tech Editing vs. Grammar?

Top answer

Get the Weekly English Kit 📬

Related Questions