Guidelines for a good quality interface specification: They must be simple, unambiguous, complete, concise, and focus on substance. Harry Hillaker |
Plain-language is writing that is logically organized
and understandable on the first reading.
You should visit the web site http://www.plainlanguage.gov/howto/guidelines/FederalPLGuidelines/index.cfm . It proides excellent examples and guidance.
The Plain Language Action and Information Network (PLAIN) is a group of federal employees from many different agencies and specialties. They maintain the US Government site on plain-language and support the use of clear communication in government writing.
Note: There is another site that has useful information about plain-language—however-- it requires membership for full access. It is http://www.plainlanguagenetwork.org/networkindex.html Note it also refers to itself as PLAIN, but this means Plain Language Association International.
Many attempts to communicate are nullified by saying too much. Robert Greenleaf |
Rambling sentences contain more information than the reader can comfortably absorb. The obvious remedy for a rambling sentence is to divide it into two or more sentences. When you do that, put the main message into the first of the revised sentences.
However, in my experience: A rambling sentence often results when a technical expert tries to provide a statement that is complete and accurate--including all limitations or restrictions--in one sentence.
My recommendation: When you fear that a technical statement or conclusion may be taken out of context, you should include a limiting phrase. You must not be vague -- identify the number of limitations and a specific source document for details -- but do not list all the limitations in the sentence.
A short saying often contains much wisdom. Sophocles |
The Handbook of Technical Writing makes important points about garbled sentences (9e page 225 or 10e page 228) and gobbledygook (9e page 233 or 10e page 236) and rambling sentences (9e page 503 or 10e page 526).
Garbled sentences often result from an attempt to squeeze too many ideas into one sentence.
Gobbledygook is writing that is stuffy, pretentious, and wordy. It uses big words, abstract words, and buzzwords in an attempt to sound official, legal, or scientific.
In my experience: Garbled sentences and gobbledygook almost always result in sentences that extend beyond three line of text.
My recommendation: When you review a draft, find and revise sentences that extend beyond three lines.
Use uncomplicated sentences to state complex ideas. The Handbook of Technical Writing (9e pages 501-2 or 10e pages 524-5) makes important points about writing effective sentences. "If readers have to cope with a complicated sentence in addition to a complex idea, they are most likely to be confused." "Avoid loading sentences with a number of thoughts carelessly tacked together. Such sentences are monotonous and hard to read because all the ideas to be of equal importance." In my experience: Long paragraphs are as problematic as long and complicated sentences. The average reader will not retain more than two key points from a long paragraph. My recommendation: Your typical paragraph should contain only two or three uncomplicated sentence. |
Blaise Pascal |
