No Parroting

Do you make the mistake of parroting the Subject Matter Expert? It's a mistake that I try to avoid, too.

Here's a great piece on that phenomena:

Parroting the Subject-Matter Expert (SME)
All professions and companies have a vocabulary that is meaningful only to those in the company or the profession. A common mistake among both SMEs and writers is to assume that the user understands the vocabulary.

To illustrate, I once shared an office with a software developer who was in charge of seeing that the separate parts of the application worked together. Every so often, someone would come in to report that a particular software function had abended. When I asked these people what abended meant, they were at such a complete loss for words it was as though I had asked them to define the word and. I could see thatabend held so much meaning for them that they were unable to condense all of its concepts into a single definition.
A short time later, I reviewed a document that contained the word abend. I called in the writer and asked him what it meant. He looked me in the eye and said, "I don't know," thus providing me with a golden opportunity to give my "Don't parrot the SME speech," which is:

As technical writers, it is our job to translate the complex and puzzling into something that everyone and anyone can understand. You and I represent Joe User. If you don't understand something, it is a sure bet that Joe User won't understand it either. Never repeat verbatim the words of the SME. Always ask for clarification.
Now I know it is embarrassing to stand in front of the SME asking questions that the SME clearly regards as stupid, but sometimes it's the only way to get information. You have to persist. And if you can't get the information from the SME, then you have to do other kinds of research. Check the Internet, go the library, read the standards. Do whatever it takes to ensure that each word, sentence, and paragraph in your document is meaningful to everyone.

Notice that my "Don't parrot the SME speech" also contains a concise definition of technical writing:
Technical writers translate the complex and puzzling into something that everyone and anyone can understand.

Finally, to find out what abend means, click here. Or, if you have installed the Google toolbar in your browser, type define: abend in the Google search box.
Abend? Let me take that one. It's a crash or sudden end that occurs in a piece of software. It's a rarely used term, so abusing it would be fairly easy if a person were, consciously or not, parroting something that a software designer had written.

Enhanced by Zemanta

War and Peace Before Borodino (With Subtitles)

War and Peace