Difference between styles of English in technical communication

Question

I have a collaborative software project with two other users. Nearly every technical report and documentation written goes through the following editorial changes to some of the sentences (examples below; note the differences in the parts in italics):

User A (original version)

1. Example X can also be written as Y
2. As is often the case, ...
3. Such programs are generally known as ...

User B (revised version)

1. Example X also can be written as Y
2. As often is the case, ...
3. Such programs generally are known as ...

Now both users are native speakers of English. As a non-native myself, I'm confused between the right style here. Both seem correct to me, but I couldn't care less either way. The consistency with which the users write these sentences makes me wonder if it is due to US/UK English conventions. An alternative explanation might be the expected style of writing in technical communication.

Can someone shed some light on this?

Answer 1

I don't think any of us can say for sure, but it looks to me like User B is holding fast to the Thou Shalt Not Split Thine Infinitives commandment (hence, don't put an also in the middle of the can be, and don't insert a generally inside the are known).

As for my personal opinion, I think the versions of User A sound more natural, and User B is sacrificing some measure of readability for the sake of adhering to strict grade-school grammar rules. If my theory is right, it might be hard for User B to concede that User A has done a better job with the edits.

Answer 2

I am in the U.S. and I agree with User A's original versions. In Claire Kehrwald Cook's book Line By Line (which I highly recommend), Ms. Cook, writes (p. 23):

An adverb modifying a verb phrase goes after the first word in the phrase (was extremely surprised, has often been said, would certainly have asked) unless, in verb phrases of three or more words, it modifies only the participle (had been justly accused, would have been officially ruled). You usually know instinctively when to put the adverb before the participle, and when you can't be sure, the position probably makes no difference.

This passage should address your last two examples. (That is, User A's wording is preferable.)

As for the placement of also, Ms. Cook writes (p. 25):

Whatever the grammatical complexities, also—meaning "in addition"—can attach itself to a variety of sentence elements, so that you have to place it carefully to avoid false connections. What element is "in addition" in the following sentence?

I also think he is lying about where he was that night.

Do you give the same answer when you read that sentence as the second of a pair?

She doesn't believe the defendant's alibi for the night of the murder. I also think he is lying about where he was that night.

I think he hated her enough to killer her. I also think he is lying about where he was that night.

The defendant lied about his pevious marriage. I also think he is lying about where he was that night.

These examples should demonstrate that also in the normal adverbial positions can sometimes seem to modify one sentence element and sometimes another, the interpretation varying with the context. Strictly speaking, the also belongs before think only when the sentence states an additional thought, as in the second example. Substituting too for also would more clearly convey the sense intended in the first example, and in the last example also belongs between is and lying.

In your first example, Example X can also be written as Y... is fine and preferable. You're talking about two ways of writing X.

Can you point this pattern of writing and revising out to the two parties involved? It is an astute observation, and they would both benefit from knowing they have a careful collaborator in you. You might recommend Line by Line, too.

Answer 3

User A's answers sound better to me. I think you should tell User B to do some constructive work instead of replacing perfectly sound phrases with strange ones.