Professional Documents
Culture Documents
1 WHY DO WE WRITE?
To develop and express ideas.
To provide evidence to support ideas.
To dispute or support existing theories.
To display knowledge.
1
a. knowledge,
b. ability,
c. interest.
A lot of technical writing fails because writers make inaccurate assumptions regarding
the people who read their documents.
Engineers often write without taking adequate time to consider the nature, needs,
interests, levels of expertise, or possible reactions of those who must read their work.
■ Knowledge:
– Are my readers engineers in my field of expertise who are seeking technical
information and will they be offended or bored by elementary details?
– Are they engineers from a different field who will need some general technical
background first?
– Are they managers or supervisors who may be less knowledgeable in my field
but who need to make executive decisions based on what I write?
– Are they technicians or others without my expertise and training but with a
strong practical knowledge of the field?
– Are they non-experts from marketing, sales, finance, or other fields who lack
engineering or technical backgrounds but who are interested in the subject for
non-engineering reasons?
– Are they a mixed audience, such as a panel or committee, made up of experts
and lay people?
■ Ability
– Am I communicating technical information on a level my audience can use?
– Am I using appropriate vocabulary, examples, definitions, and depth of
detail?
– Am I expecting more expertise, skill, or action from my audience than I can
reasonably expect?
■ Interest
– Why will my audience want to spend time reading this document?
– Does my document provide the right level of detail and technology to keep my
audience’s interest without losing them or boring them?
– What is their current attitude likely to be – positive, neutral, or negative?
– Will my document give them the information they want?
2
Answering these questions will increase your awareness of the multiple decisions and
choices to be made as you plan, write, or revise your document.
To deliver a clear message, you must first assess your audience.
Properly analyze technical knowledge, expectations, and attitude toward the subject,
so you can address them in your document.
4. Establish a focus
Get to the point in your title
General Specific
2.2 Researching
1. Search for relevant journals/books/information in the library and on the internet.
2. Write down the details of your sources; highlight/take notes of relevant information.
3. Do some reading.
4. Decide if you need to do more reading.
2.3 Writing Up
1. Write the first complete draft.
2. Read the first draft.
3. Edit the draft – decide objectively whether your ideas have been expressed clearly.
4. Arrange a tutorial with me.
5. Write the contents page, references, title page and abstract.
3
3 TITLE: GENERAL TO SPECIFIC
Heading: ____________________________
____________________________________
____________________________________
____________________________________
____________________________________
Heading: ____________________________
____________________________________
____________________________________
____________________________________
____________________________________
Heading: ____________________________
____________________________________
____________________________________
____________________________________
____________________________________
Heading: ____________________________
____________________________________
____________________________________
____________________________________
____________________________________