Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                

Chapter 2 Functional English

Download as docx, pdf, or txt
Download as docx, pdf, or txt
You are on page 1of 11

Sure!

Here's a simplified version of Chapter 2's important details with examples, so it's easier to
understand for your quiz preparation.

2.1 Introduction

People often think that engineers and technical professionals are bad at writing, but that's not
always true. Many engineers are good at it! This chapter helps improve technical writing skills
with practical tips rather than basic grammar rules.

2.2 Structuring Your Writing

Technical writing should be well-organized, like an outline. Start with big sections and break
them down into smaller parts.

Example:

1. Main Section (big idea)


o 1.1 Subsection (smaller idea)
 1.1.1 Details (even smaller ideas)

The writing should be balanced, with each section having similar amounts of detail. If your
document lacks balance, it can either have too much high-level or too much low-level
information, making it hard to follow.

2.3 Positioning Your Writing

2.3.1 Know Your Audience

Write based on who is going to read your work. If it's for technical people, use more details and
specific terms. If it's for non-technical readers, explain things simply.

Example:

 Writing for engineers: "This engine has a 4-stroke combustion cycle."


 Writing for non-engineers: "The engine works in four steps: intake, compression, power,
and exhaust."

2.3.2 Are You Talking to Me?

There are three points of view:

 First-person: Use "I" or "we." Example: "I tested the system."


 Second-person: Use "you." Example: "You need to start the engine."
 Third-person: Use "he," "she," or "they." Example: "The technician checked the
system."

Be consistent with the point of view you choose throughout your document.

2.4 Choosing the Right Words

2.4.1 Conciseness

Concise writing means saying more with fewer words. Don't use long sentences or unnecessary
words.

Example:

 Too wordy: "The mechanism will need to undergo a significant amount of redesigning."
 Concise: "The mechanism will need redesigning."

2.4.2 Precision and Hedging

Technical writing needs to be precise. Avoid vague words like "a lot" or "some." Use exact
numbers or measurements instead.

Example:

 Vague: "A lot of fluid might leak."


 Precise: "Less than 10 milliliters of fluid may leak per day."

2.4.3 Universal and Existential Quantification

This is about using words like "all" or "some" correctly. If something applies to everything, use
"all." If it applies to some cases, say "some."

Example:

 Universal: "All cars have wheels."


 Existential: "Some cars have leather seats."

2.4.4 Negatives

Avoid using too many negatives (words like "not" or "never"). It can confuse readers. Keep it
simple.

Example:

 Confusing: "It is not unlikely that the machine will fail."


 Better: "The machine will likely fail."
2.5 Avoiding Traps

2.5.1 Clichés

Avoid overused phrases like "think outside the box." They don’t add value and can make your
writing sound unoriginal.

Example:

 Cliché: "We need to push the envelope."


 Better: "We need to improve our design process."

2.5.2 Anthropomorphic Writing

Don't give human traits to machines or systems. Systems don't "think" or "decide."

Example:

 Wrong: "The computer decided to stop working."


 Correct: "The computer stopped working."

2.5.3 Malapropisms

Malapropisms are when you use the wrong word that sounds like the right one. This confuses
readers.

Example:

 Wrong: "We need to affect the project quickly." (Should be "effect")


 Correct: "We need to effect changes quickly."

2.5.4 Erroneous Heterographs

These are words that sound the same but have different meanings, like "their," "there," and
"they’re." Use them correctly!

Example:

 Wrong: "There going to the meeting."


 Correct: "They’re going to the meeting."

2.5.5 Opinion versus Fact

Only write facts, not opinions. Stick to what can be proven.

Example:
 Wrong: "I believe this design is the best."
 Correct: "This design reduces energy consumption by 20%."

2.5.6 Acronyms, Domain-Specific Terms, and Jargon

If your audience doesn’t know technical terms or acronyms, explain them the first time you use
them.

Example:

 First time: "We are using a Graphical User Interface (GUI)."


 After that: "The GUI allows easy navigation."

2.5.7 The Laziness of "Very"

Avoid using "very" because it's weak. Use stronger words instead.

Example:

 Weak: "The engine is very powerful."


 Stronger: "The engine is powerful."

2.6 Making Your Technical Writing More Interesting

Even though technical writing is usually serious, it doesn’t have to be boring. Adding a bit of
humor or interesting examples can make your writing more enjoyable, but be careful not to
overdo it.

Example:

Instead of writing, "Spam filters are essential," try adding humor: "Spam filters are like
bodyguards, protecting your inbox from unwanted guests."

2.7 The 5 Cs of Technical Writing

1. Correctness: Your writing must be accurate.


o Example: Use correct grammar and data.
2. Clarity: Make sure it’s easy to understand.
o Example: Avoid complicated words when simple ones will do.
3. Completeness: Include all necessary details.
o Example: Don’t skip steps in instructions.
4. Consistency: Use the same style, terminology, and format throughout the document.
o Example: If you start with "Step 1," don’t later write "Part A."
5. Changeability: Make it easy to update.
o Example: Use flexible wording so the text can be updated when needed.
2.8 Referencing

Always cite your sources properly. Different types of writing use different citation styles (like
APA or MLA). Follow the required format for your work.

Example:

 Book citation (APA):


o Author, A. (Year). Title of book. Publisher.

2.9 Exercises

At the end of this chapter, there are exercises where you practice writing concisely, fixing
clichés, and structuring your writing better.

Important Tips for Your Quiz:

1. Be concise: Always try to say more with fewer words.


2. Use precise language: Replace vague words like "some" with exact numbers.
3. Avoid clichés: Get rid of overused phrases like "thinking outside the box."
4. Stay fact-based: Don’t mix your opinions with facts in technical writing.
5. Understand your audience: Adjust your tone and details to fit who is reading.
6. Use clear structure: Organize your writing in a hierarchical way.
7. Reference properly: Always cite your sources and use the correct citation format.

Good luck with your quiz! You'll do great


Since you have a quiz on Chapter 2 of "Technical Writing: A Practical Guide," I'll provide more
detailed information from the sections I summarized earlier. This will ensure you are well-
prepared.

2.1 Introduction

This section introduces the stereotype that technical professionals are poor communicators.
However, the author believes many technical professionals, including engineers and scientists,
are actually good communicators. The chapter aims to give rules to improve technical writing,
assuming that the reader already knows basic writing principles like grammar, punctuation, and
sentence structure.

2.2 Structuring Your Writing

Technical writing should follow a hierarchical structure. This means arranging information
from general to specific, using sections, subsections, and sub-subsections.

Numbering Scheme:

 First-Level Heading: 1
 Second-Level Heading: 1.1
 Third-Level Heading: 1.1.1
 Fourth-Level Heading: 1.1.1.1

The key is balance:

 External Balance: Each section should be relatively uniform in the number of


subsections.
 Internal Balance: The length of sections and subsections should be proportional.

If you don’t maintain balance, you might get the following shapes:

 Pyramid: Ideal, meaning more details in lower levels.


 Hourglass: Too many high-level and low-level sections but lacking in mid-level detail.
 Diamond: Too much mid-level detail, not enough in the higher and lower sections.

2.3 Positioning Your Writing

2.3.1 Know Your Audience

Understanding the audience is crucial to technical writing. You must adjust your tone and the
level of detail based on the readers. For example:

 Non-technical readers need explanations of basic concepts.


 Technical readers want detailed information.
 Multiple audiences require a formal and neutral tone, especially if different groups (e.g.,
customers, government agencies, vendors) will read the document.

2.3.2 Are You Talking to Me?

There are three types of perspectives used in writing:

 First-person: Uses "I" or "we". Common in autobiographies, some business


communications, and personal reports.
 Second-person: Directly addresses the reader as "you." Common in user guides or
manuals.
 Third-person: More formal and objective. Uses "he," "she," or "they." Common in
technical reports and scientific writing.

For consistency, avoid switching between different points of view within the same document.

2.4 Choosing the Right Words

2.4.1 Conciseness

Concise writing uses only the words necessary to convey the meaning. You should avoid
redundant phrases and long-winded sentences.

Example of word reduction:

 Original: "The mechanism will require a substantial amount of redesign."


 Revised: "The mechanism will require substantial redesign."

This type of editing makes your writing more professional and clearer. Always aim to replace
long phrases with precise, single words.

2.4.2 Precision and Hedging

Precision is critical in technical writing. Avoid vague words like "some," "many," "countless,"
"huge," "tiny," and instead, provide specific measurements.

Example of improvement:

 Original: "This should result in minimal leakage."


 Revised: "This should result in less than one milliliter of leakage per day."

Using exact numbers makes your writing trustworthy and authoritative.

2.4.3 Universal and Existential Quantification


Technical writing needs to distinguish between universal (applies to all cases) and existential
(applies to some cases) statements. Misusing these can lead to incorrect conclusions.

Examples:

 Universal: "All parts must pass inspection."


 Existential: "Some parts may fail under extreme conditions."

2.4.4 Negatives

Avoid double negatives and overly complex negative constructions. These can confuse the
reader. Keep the language clear and simple.

2.5 Avoiding Traps

2.5.1 Clichés

Clichés are overused phrases that weaken your writing. For example, phrases like "thinking
outside the box" or "pushing the envelope" are vague and often meaningless in technical writing.
Avoid them.

2.5.2 Anthropomorphic Writing

This is when you give human traits to inanimate objects. Avoid writing things like "the computer
decided" or "the system wants." Systems and machines don’t have intentions or desires.

2.5.3 Malapropisms

These are incorrect uses of words that sound similar to the intended word but mean something
different. For example, saying "affect" when you mean "effect" is a malapropism. These errors
hurt your credibility.

2.5.4 Erroneous Heterographs

These are words that sound the same but are spelled differently and have different meanings
(e.g., "there" vs. "their"). Ensure correct usage to avoid confusion.

2.5.5 Opinion versus Fact

Technical writing must focus on facts supported by data. Avoid stating opinions as facts. Words
like "I believe" or "I feel" should be avoided unless you are explicitly asked to give your opinion.

2.5.6 Acronyms, Domain-Specific Terms, and Jargon

Acronyms and jargon should only be used if you know the reader is familiar with them. Always
spell out acronyms the first time they appear and define technical terms when necessary.
2.5.7 The Laziness of "Very"

The word "very" is often unnecessary and weakens writing. Instead of saying something is "very
important," try to find a stronger word like "critical" or "essential."

2.5.8 Other Pitfalls

Other common pitfalls in technical writing include vague terms (e.g., "stuff," "things") and
subjective language (e.g., "amazing," "incredible"). These should be avoided to maintain
objectivity and clarity.

2.6 Making Your Technical Writing More Interesting

Although technical writing is often formal and dry, it can still be engaging. Occasionally using
humor or interesting anecdotes can make your writing more enjoyable to read. However, this
must be done cautiously and should not distract from the main content.

2.7 The 5 Cs of Technical Writing

These five qualities define effective technical writing:

1. Correctness: Writing must be accurate in terms of both content and grammar. Incorrect
information can lead to serious consequences.
2. Clarity: Ambiguous or unclear writing can cause misunderstandings. Make sure your
writing conveys only one interpretation.
3. Completeness: Include all necessary information to avoid gaps in the reader's
understanding.
4. Consistency: Use consistent terminology, formatting, and tone throughout the document.
5. Changeability: The document should be easy to modify when needed, such as when
standards or requirements change.

2.8 Referencing

When referencing other work, make sure to choose reliable sources. For online references, make
sure the websites are credible and stable. There are several citation styles (APA, MLA, IEEE), so
follow the required format.

2.9 Exercises

The chapter ends with exercises that test your understanding of technical writing concepts. These
tasks include identifying clichés, correcting imprecise writing, and analyzing the structure of
different documents.

Important Tips for Your Quiz:


1. Understand the 5 Cs of technical writing (Correctness, Clarity, Completeness,
Consistency, Changeability).
2. Know the importance of audience awareness and how to adjust your writing
accordingly.
3. Practice recognizing and improving conciseness and precision in sentences.
4. Avoid common mistakes like clichés, malapropisms, and anthropomorphisms.
5. Be able to differentiate between opinion and fact in writing.
6. Understand how to structure your writing hierarchically, maintaining a balance between
sections.
7. Use references properly, following appropriate citation styles.

You might also like