TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
> I'm doing some research on car repair manuals. A typical writing style
> here seems to be some sort of "shorthand" English, in which articles
> and pronouns are omitted. For example:
>
> - "Remove fuel tank cover."
> - "Drain fuel tank and clean fuel filler neck and surrounding area."
> - "Unscrew securing bolt and remove tank flap unit with rubber cup."
> - "Remove securing bolts on filler neck."
> - "Ensure fuel hoses are tight."
>
> Any thoughts/opinions about this writing style? Pros and cons? Where
> does this writing style come from? Effect on the readability and
> translatability of the text?
Yves:
Removal of articles and prepositions is a false economy; instructions
written this way take longer to read and parse than instructions written
in real English.
For people whose first language isn't English, this style can be
exceedingly hard to understand, mostly because the lack of articles and
prepositions makes it difficult to determine parts of speech:
"Remove fuel tank cover": Does that mean "remove the fuel tank and
cover it"? Remove the fuel, the tank, AND the cover?
"Drain fuel tank and clean fuel filler neck and surrounding area":
Am I to drain the fuel tank, the clean fuel filler neck, AND the
surrounding area?
"Unscrew securing bolt": Unscrew it WHILE securing it? How?
"Remove tank flap unit with rubber cup": Am I being instructed to
use a rubber cup instead of a prybar? Or to remove this unit but
leave installed the unit that doesn't have a rubber cup?
This problem was identified decades ago by the aerospace industry; they
addressed it with "Simplified Technical English": a dictionary and set
of rules for writing aircraft maintenance manuals. Info on the spec
(which is available for a fee) is here:
=== Andrew Warren - awarren -at- synaptics -dot- com
=== Synaptics, Inc - Santa Clara, CA
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l
Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-