2008-05-16

Changing the Interface

I use a four-part description of how to use a Jack Plane as a basis for comparison when working out how to explain how to use software tools. When I write a user manual, I need to be sure that if the software publisher redesigns the interface that it will have only the most minimal effect on the descriptions of any functionalities.

Supposing that the manufacturer of the jack pane decides to make a version where the rear handle ('tote') is shaped like a saw handle (poignée à jour) instead of the classic swan-neck? I'll update the section that describes the parts, and possibly the assembly. I'd expect to have to add a short explanation of why the manufacturer has chosen to deviate from a well-established pattern.

I would not expect to have to change any explanation of how to use the plane.

What are words?

Before literacy was generalized words were sounds. In our post-literate age words have acquired meanings from the way we try to capture store and retrieve them. They have a meta-meaning that is carried by the symbols we use to record them. Put plainly: spelling has meaning.

Before written language the only meaning of a word was in its sound.

Through has the same number of syllables, and the same number of sounds as ski. But what one acheives in three letters, the other uses seven.

(In Italian, both would have three letters.)

This is a problem for anyone who needs to use written communication. English and French are my main languages, and both are rife with words that have meta-meanings.

Show has meta-tags that imply basicness, simplicity, classroom.

Demonstrate has meta tags that imply practicality, complexity, detail, product.

Yet the the words are not synonymous. There is a nuance. To show something is to draw attention to its existance. To demonstrate something is to "show" how it works.

Compare: "Let me show you my cow."

With: "Let me demonstrate my cow."

Even so demonstrate is often selected when show is notrong; largely I suspect from a desire to avoid underselling.

I won't go into the origins of spelling and meta-meanings here; that isn't my purpose.

The two complications combine to make my job difficult. Because I write for international readers in English I sometimes find myself opting to show and tell even when demonstrate and imform would be more accurate. I often choose the words with the simplest spellings and simplest or least ambiguous meta-meanings. Frequently I choose the shortest words, since their meaning is least likely to be confused with words or groups of words in the reader's native language.

The result is plain but irregular. And rather stilted and impoverished for someone who relishes the meticulous precision with which Jonathan Meades employs his vast and varied vocabulary, and Virgil's eight page similes (sillymes) .

Nonetheless I'm going to add some posts about how to wrangle rope and brand in Plain English.