venta: (Default)
[personal profile] venta
At work, I am currently reviewing a big pile of technical documentation. Largely because no one understands it. Except the guy who wrote it, who understands it perfectly and doesn't see what the fuss is about. So I am reading, asking him questions, re-writing, asking him more questions, trying to explain to someone else, realising I don't understand at all, rinse, repeat. Everything he's written is correct, it just needs a lot more explanation and examples adding.

The writer's first language is German and, while he speaks (and writes) excellent English, he does occasionally use words in a way a native speaker wouldn't. In particular, several of us have been thrown by his describing certain objects as "contenders".

Contenders for what? we ask.

It turns out that in some cases, we might end up with conflicting objects. These objects are in contention. And a thing that's in contention? That's a contender.

Which intrigues me. A contender - one who contends - clearly is in contention. I can't fault the logic. However, I don't think that's a usage of contender which comes naturally in English.

Would any of you use contender in that way? I'm particularly interested to hear from people who might be writing (or reading) technical docs relating to things in contention :)

(I've changed it, since it confused at least three people here. I've gone for the rather more verbose "object with a conflicting ID".)

In any case, the net effect is that I have been singing Heavyweight Champion of the World on and off for two days. Which is slightly more fortunate than another colleague, who immediately associated it with Gladiators instead :)

Date: 2012-09-26 09:33 am (UTC)
From: [identity profile] bateleur.livejournal.com
I wouldn't use "contender" in that way, although I rather like it. :-)

Date: 2012-09-26 09:48 am (UTC)
From: [identity profile] venta.livejournal.com
Yeah, I kind of like the logic of it :)

However, apparently I'm supposed to go for clarity, not for fun :(

Date: 2012-09-26 09:39 am (UTC)
From: [identity profile] beckyc.livejournal.com
No, I really wouldn't use it that way.

Though I do like it. Maybe I'll work on spreading that usage ;-).

Date: 2012-09-26 09:52 am (UTC)
From: [identity profile] lanfykins.livejournal.com
I see the logic, but no, that's not how 'contenders' would normally be used. And since technical writing is all about being as clear and concise as possible, you should avoid being playful with language at almost all costs.

(I say almost, because Twain's advice to 'break any rule rather than say anything outright barbarous' applies in All Circumstances :) )

In general, the aim when editing bad technical writing should be to end up with something a lot shorter that contains more and better information :)

Date: 2012-09-26 09:54 am (UTC)
From: [identity profile] venta.livejournal.com
I think if I made this any shorter it would vanish! It is extraordinarily terse at present. I think my overall aim is to make it considerably more verbose and exigetic (preferably without adding too much waffle).

Date: 2012-09-26 09:58 am (UTC)
From: [identity profile] lanfykins.livejournal.com
Ooh, that's unusual. Most of the time, bad technical writing is longer than it should be. Lucky you!

Examples are a Good Plan, especially if you make them relevant to what people will actually try to do with the tech, rather than just what it does. Am I alone in finding example-writing oddly fun?

Date: 2012-09-26 10:02 am (UTC)
From: [identity profile] venta.livejournal.com
I don't find exampe-writing fun, but it is very satisfying because docs which don't have examples are sucky.

Example code is often a faff, though, because you have to write so much which isn't strictly relevant in order to provide a context for the thing that you actually want to demonstate. (Assuming you need stuff which can be compiled and run, rather than just illustrative snippets.)
Edited Date: 2012-09-26 10:02 am (UTC)

Date: 2012-09-26 10:38 am (UTC)
From: [identity profile] lanfykins.livejournal.com
I see your point. Fortunately these days I'm mostly working at a higher level than code, so my examples mostly involve thinking up a scenario and then explaining how it's done.

The example for 'how to make a set of decision tables rather than one humungous table' was a bit tedious, though, I'll confess :)

Date: 2012-09-26 10:58 am (UTC)
From: [identity profile] venta.livejournal.com
humungous

See also: documentation, words which probably shouldn't appear in

:)

Date: 2012-09-26 11:04 am (UTC)
From: [identity profile] lanfykins.livejournal.com
I still regularly sulk that I have to use words like 'component' or 'module' imprecisely rather than just being able to say thing :)

Date: 2012-09-27 05:28 pm (UTC)
From: [identity profile] venta.livejournal.com
Which is odd, because I'm quite sure it's exegesis, but apparently think it's exigetic.

Date: 2012-09-26 10:32 am (UTC)
From: [identity profile] rabbit1080.livejournal.com
I think your version is much clearer because it states which aspect of the objects are in contention (their IDs).

(As part of electronicifying my library, I've just bought OED's iPad dictionary/thesaurus. I haven't yet decided whether I'll also be keeping my paper Shorter OED. The paper version has more definitions of "contend" than the iPad version, but it's easier to find words in the latter. Hmmmm.)

Date: 2012-09-26 10:40 am (UTC)
From: [identity profile] leathellin.livejournal.com
I spend quite a lot of time at work reviewing documents written by colleagues with a first language of either French, Flemish or Polish (depending on the colleague anyway). They all have very good English - our language just isn't logical :-)
One colleague loves the word "timely" and just can't get using it correctly. Another has the as is/as such problem. "Since ten years" is pretty common as well.

The documents I hate reading are the ones written by a German former colleague who had a very good vocabulary and was also a show off. They have mistakes I have plenty of sympathy for but are also completely unreadable when they are correct :-)

Date: 2012-09-26 10:58 am (UTC)
From: [identity profile] venta.livejournal.com
Mind you, some of the real documentary horrors in our office are committed by the people who are native English speakers :)

Date: 2012-09-26 11:03 am (UTC)
From: [identity profile] leathellin.livejournal.com
Probably at least a couple by people who haven't had their coffee yet this morning... :-)
There are almost certainly plenty of those in our office. I just don't have to review them :-)

Date: 2012-09-26 10:47 am (UTC)
From: [identity profile] leathellin.livejournal.com
On a similar but slightly tangential point - Spanish and French have the word "Planificación/planification" which sort of exists in English but should be much more commonly used :-)

Date: 2012-09-26 10:48 am (UTC)
From: [identity profile] metame.livejournal.com
Wouldn't use it, can easily see how it happened.

The one I see a lot of atm in similar "parts of speech a native wouldn't get to" vein is "edition", meaning "the act of editing".
There seems to be an increasing issue where spellcheckers let a word through, but it doesn't quite mean what it might.

Date: 2012-09-26 10:52 am (UTC)
From: [identity profile] venta.livejournal.com
Lovely :) Edition is so close to being correct ("I was involved in the edition of this newspaper/this edition of the newspaper") that it's pretty easy to see why it happens.

I remember being very distressed as a child to realise that there were some words in English that didn't exist. If one displays precocity, one is precocious. If one displays temerity, one is...

Temerous isn't a word. And when I tried to find out what the correct adjective was, my mother coolly informed me that there wasn't one. My logical brain was horrified at this omission :)

Date: 2012-09-26 10:58 am (UTC)
From: [identity profile] vicarage.livejournal.com
And you can be timorous, but can't display timority, unless you are snob called Tim.

Date: 2012-09-26 11:30 am (UTC)
From: [identity profile] venta.livejournal.com
Ah, yes! I knew I had a pet example of the opposite problem, but couldn't recall it :)

Date: 2012-09-26 04:04 pm (UTC)
From: [identity profile] undyingking.livejournal.com
This is because English forms -ous adjectives in two different ways. One group are essentially '[noun]ous', meaning "being like [noun]", so have no need for a '[noun]ity' noun. The other group are '[adjective]ous', meaning "adjective, but easier to pronounce", so a '[noun]ity' noun gets formed to complement them.

'Timorous' suffers from its stem noun, 'timor', being lost to archaism.

'Temerity' suffers from being directly imported from French without its stem having ever been present in English afaik :-)

Date: 2012-09-27 11:11 am (UTC)
From: [identity profile] vicarage.livejournal.com
I must admit the only reference to timorous I know is Rabbie Burns!

Date: 2012-09-26 11:57 am (UTC)
triskellian: (semi colon)
From: [personal profile] triskellian
See also my attempt, while in the depths of essay crisis, to use 'emergency' as 'the state of being emergent', which fortunately I caught in time.

Date: 2012-09-26 01:38 pm (UTC)
From: [identity profile] venta.livejournal.com
I remember a friend of mine writing an essay (she was a classicist) when rather tired and inadvertently misspelling "hypocrisy" as "hippocracy".

It returned from her tutor with some fairly terse comments about the problems of allowing horses to run the show...

Date: 2012-09-27 11:13 am (UTC)
From: [identity profile] vicarage.livejournal.com
Hippocracy - when doctors euthanize.

Date: 2012-09-26 02:48 pm (UTC)
From: [identity profile] drdoug.livejournal.com
It's all a bit On The Waterfront: "You don't understand. I coulda had class, but I was only an instance. I coulda been a contender, but my ID was unique."

Date: 2012-09-26 03:06 pm (UTC)
From: [identity profile] lanfykins.livejournal.com
I should not find that funny :)

(We don't need no emulation, we don't need no source control...)

Date: 2012-09-27 04:22 am (UTC)
ext_54529: (greenstripes)
From: [identity profile] shrydar.livejournal.com
You're both killing me :D

Profile

venta: (Default)
venta

December 2024

S M T W T F S
1234567
891011121314
15161718192021
2223 2425262728
293031    

Most Popular Tags

Style Credit

Expand Cut Tags

No cut tags
Page generated Jun. 18th, 2025 10:19 am
Powered by Dreamwidth Studios
OSZAR »