SlideShare a Scribd company logo
1 of 99
Week 2: Audiences, Research,
Organization, Proposals, Definitions &
            Descriptions

                       ENG 3302
                         Winter
                       Roundtree


Chapter 5. Analyzing Your Audience and Purpose   ©
2012 by Bedford/St. Martin's
Table of Contents
Analyzing Your Audience and Purpose…….…slide 3
Researching Your Subject…………………...….slide 16
Organizing Your Information…………………....slide 39
Writing Proposals…………………………….…..slide 54
Writing Definitions, Descriptions Instructions….slide 72




    Chapter 5. Analyzing Your Audience and Purpose   ©
    2012 by Bedford/St. Martin's
Analyzing Your Audience and Purpose




Chapter 5. Analyzing Your Audience and Purpose   ©
2012 by Bedford/St. Martin's
Determine four important
     characteristics of your audience:

• Who are your readers?
• Why is your audience reading your
  document?
• What are your readers’ attitudes and
  expectations?
• How will your readers use your document?


   Chapter 5. Analyzing Your Audience and Purpose   © 2012 by Bedford/St. Martin's   4
Consider six factors about
         your most important readers:

• the reader’s education
• the reader’s professional experience
• the reader’s job responsibility
• the reader’s personal characteristics
• the reader’s personal preferences
• the reader’s cultural characteristics

   Chapter 5. Analyzing Your Audience and Purpose   © 2012 by Bedford/St. Martin's   5
Classify your readers into three categories:

 • a primary audience of people who will use
   your document in carrying out their jobs
 • a secondary audience of people who need to
   stay aware of developments in the
   organization but who will not directly act on or
   respond to your document
 • a tertiary audience of people who might take
   an interest in the subject of the document
    Chapter 5. Analyzing Your Audience and Purpose   © 2012 by Bedford/St. Martin's   6
Your readers have
           attitudes and expectations:

• attitudes toward you
• attitudes toward the subject
• expectations about the document




   Chapter 5. Analyzing Your Audience and Purpose   © 2012 by Bedford/St. Martin's   7
Why and how will your
         readers use your document?

• Why is the reader reading your document?
• How will the reader read your document?
• What is the reader’s reading skill level?
• What is the physical environment in which the
  reader will read your document?



   Chapter 5. Analyzing Your Audience and Purpose   © 2012 by Bedford/St. Martin's   8
Learn about your audience:

• Determine what you already know about your
  audience.
• Interview people.
• Read about your audience online.
• Search social media for documents your
  audience has written.


   Chapter 5. Analyzing Your Audience and Purpose   © 2012 by Bedford/St. Martin's   9
Understand seven cultural
    variables that lie “on the surface”:

• political
• economic
• social
• religious
• educational
• technological
• linguistic
   Chapter 5. Analyzing Your Audience and Purpose   © 2012 by Bedford/St. Martin's   10
Understand six cultural variables
     that lie “beneath the surface”:

• focus on individuals or groups
• distance between business life and private life
• distance between ranks
• nature of truth
• need to spell out details
• attitudes toward uncertainty

   Chapter 5. Analyzing Your Audience and Purpose   © 2012 by Bedford/St. Martin's   11
Consider four points about
cultural variables “beneath the surface”:

• Each variable represents a spectrum of
  attitudes.
• The six variables do not line up in a clear
  pattern.
• Different organizations within the same culture
  can vary greatly.
• An organization’s cultural attitudes are fluid,
  not static.
   Chapter 5. Analyzing Your Audience and Purpose   © 2012 by Bedford/St. Martin's   12
Use these eight strategies when
   writing for readers from other cultures:

• Limit your vocabulary.
• Keep sentences short.
• Define abbreviations and acronyms in a
  glossary.
• Avoid jargon unless you know your readers are
  familiar with it.



     Chapter 5. Analyzing Your Audience and Purpose   © 2012 by Bedford/St. Martin's   13
Use these eight strategies when writing
    for readers from other cultures (cont.):

•   Avoid idioms and slang.
•   Use the active voice whenever possible.
•   Be careful with graphics.
•   Be sure someone from the target culture reviews
    the document.




       Chapter 5. Analyzing Your Audience and Purpose   © 2012 by Bedford/St. Martin's
Determine your purpose:


Ask yourself:
• What do I want this document to accomplish?
• What do I want readers to know or believe?
• What do I want readers to do?




   Chapter 5. Analyzing Your Audience and Purpose   © 2012 by Bedford/St. Martin's   15
Researching Your Subject




Chapter 5. Analyzing Your Audience and Purpose   ©
2012 by Bedford/St. Martin's
Understand the differences between
 academic and workplace research:

• In academic research, your goal is to find
  information that will help you answer a
  scholarly question.
• In workplace research, your goal is to find
  information that will help you answer a
  practical question, usually one that involves
  the organization for which you work.


      Chapter 6. Researching Your Subject   © 2012 by Bedford/St. Martin's   17
The research process consists of 12 steps:
 •   Analyze your audience.
 •   Analyze your purpose.
 •   Analyze your subject.
 •   Visualize the deliverable.
 •   Work out a schedule and a budget.
 •   Determine what information will need to be
     part of that deliverable.



         Chapter 6. Researching Your Subject   © 2012 by Bedford/St. Martin's   18
The research process
        consists of 12 steps (cont.):
• Determine what information you still need to
  acquire.
• Create questions you need to answer in your
  deliverable.
• Conduct secondary research.
• Conduct primary research.
• Evaluate your information.
• Do more research.

      Chapter 6. Researching Your Subject   © 2012 by Bedford/St. Martin's   19
Choose appropriate research methods:

• What types of research media might you use?
• What types of research tools might you use?
• What types of primary research might you
  conduct?




     Chapter 6. Researching Your Subject   © 2012 by Bedford/St. Martin's   20
Follow three guidelines
         when researching a topic:

• Be persistent.
• Record your data carefully.
• Triangulate your research methods.




     Chapter 6. Researching Your Subject   © 2012 by Bedford/St. Martin's   21
Know the four types of information media:

 • print
 • online databases
 • Web sites
 • social media




       Chapter 6. Researching Your Subject   © 2012 by Bedford/St. Martin's   22
Know how to use six basic research tools:

•   online catalogs
•   reference works
•   periodical indexes
•   newspaper indexes
•   abstract services
•   government information


        Chapter 6. Researching Your Subject   © 2012 by Bedford/St. Martin's   23
Understand these five forms of social media:

  • discussion boards
  • wikis
  • blogs
  • tagged content
  • RSS feeds



        Chapter 6. Researching Your Subject   © 2012 by Bedford/St. Martin's   24
Look for information that is . . .

•   accurate
•   unbiased
•   comprehensive
•   appropriately technical
•   current
•   clear


        Chapter 6. Researching Your Subject   © 2012 by Bedford/St. Martin's   25
When evaluating print and online
    sources, examine these five factors:

•   authorship
•   publisher
•   knowledge of the literature
•   accuracy and verifiability of the information
•   timeliness




        Chapter 6. Researching Your Subject   © 2012 by Bedford/St. Martin's   26
Understand the seven techniques
           of primary research:

•   observations and demonstrations
•   inspections
•   experiments
•   field research
•   interviews
•   inquiries
•   questionnaires

        Chapter 6. Researching Your Subject   © 2012 by Bedford/St. Martin's   27
Conducting an experiment
            consists of four phases:

•   establishing a hypothesis
•   testing the hypothesis
•   analyzing the data
•   reporting the data




        Chapter 6. Researching Your Subject   © 2012 by Bedford/St. Martin's   28
Field research is vulnerable
         to two common problems:

• the effect of the experiment on the behavior
  you are studying
• bias in the recording and analysis of the data




      Chapter 6. Researching Your Subject   © 2012 by Bedford/St. Martin's   29
Consider three factors
 when choosing a person to interview:

• What questions do you want to answer?
• Who could provide the information you need?
• Is the person willing to be interviewed?




      Chapter 6. Researching Your Subject   © 2012 by Bedford/St. Martin's   30
Prepare for the interview:

• Do your homework.
• Prepare good questions.
• Check your equipment.




      Chapter 6. Researching Your Subject   © 2012 by Bedford/St. Martin's   31
Begin the interview:

•   Arrive on time.
•   Thank the respondent.
•   State the subject and purpose of the interview.
•   If you want to record the interview, ask
    permission.




        Chapter 6. Researching Your Subject   © 2012 by Bedford/St. Martin's   32
Conduct the interview:

•   Take notes.
•   Start with prepared questions.
•   Be prepared to ask follow-up questions.
•   Be prepared to get the interview back on
    track.




        Chapter 6. Researching Your Subject   © 2012 by Bedford/St. Martin's   33
Conclude the interview:

• Thank the respondent.
• Ask for a follow-up interview.
• Ask for permission to quote the respondent.




      Chapter 6. Researching Your Subject   © 2012 by Bedford/St. Martin's   34
After the interview, do two tasks:

• Write down the important information while the
  interview is fresh in your mind.
• Send a brief thank-you note.




      Chapter 6. Researching Your Subject   © 2012 by Bedford/St. Martin's   35
Questionnaires are
      vulnerable to three problems:

• Some of the questions will misfire.
• You won’t obtain as many responses as you
  want.
• You cannot be sure the respondents are
  representative.




      Chapter 6. Researching Your Subject   © 2012 by Bedford/St. Martin's   36
Using questionnaires effectively
            calls for four steps:

•   Ask effective questions.
•   Test the questionnaire.
•   Administer the questionnaire.
•   Present questionnaire data in your document.




        Chapter 6. Researching Your Subject   © 2012 by Bedford/St. Martin's   37
Understand the six
         common types of questions:

•   multiple choice
•   Likert scale
•   semantic differentials
•   ranking
•   short answer
•   short essay


        Chapter 6. Researching Your Subject   © 2012 by Bedford/St. Martin's   38
Organizing Your Information




Chapter 5. Analyzing Your Audience and Purpose   ©
2012 by Bedford/St. Martin's
Understand three principles for
    organizing technical information:

• Analyze your audience and purpose.
• Use conventional patterns of organization.
• Display your organizational pattern
  prominently in the document.




     Chapter 7. Organizing Your Information   © 2012 by Bedford/St. Martin's   40
Ask four questions when you
 study documents from other cultures:

• Does the text follow expected organizational
  patterns?
• Do the introductions and conclusions present
  the kind of information you would expect?
• Does the text appear to be organized linearly?
• Does the text use headings? If so, does it use
  more than one level?

     Chapter 7. Organizing Your Information   © 2012 by Bedford/St. Martin's   41
Display your organizational
            pattern prominently:


• Create a detailed table of contents.
• Use headings liberally.
• Use topic sentences at the beginnings of your
  paragraphs.




     Chapter 7. Organizing Your Information   © 2012 by Bedford/St. Martin's   42
Understand eight typical
             patterns of organization:

• chronological
• spatial
• general to specific
• more important to less important
• comparison and contrast
• classification and partition
• problem-methods-solution
• cause and effect
      Chapter 7. Organizing Your Information   © 2012 by Bedford/St. Martin's   43
Follow these three guidelines for
organizing information chronologically:

• Provide signposts.
• Consider using graphics to complement the
  text.
• Analyze events where appropriate.




     Chapter 7. Organizing Your Information   © 2012 by Bedford/St. Martin's   44
Follow these three guidelines for
   organizing information spatially:

• Provide signposts.
• Consider using graphics to complement the
  text.
• Analyze events where appropriate.




     Chapter 7. Organizing Your Information   © 2012 by Bedford/St. Martin's   45
An example of
information organized spatially




                                                                          Source:
                                                                          Metropolitan
                                                                          Museum of Art,
                                                                          2010
                                                                          <www.metmuseum.
                                                                          org/toah/world-
                                                                          regions/#/09/World-
                                                                          Map>.




Chapter 7. Organizing Your Information   © 2012 by Bedford/St. Martin's                46
Follow these two guidelines for organizing
   information from general to specific:

 • Provide signposts.
 • Consider using graphics to complement the
   text.




      Chapter 7. Organizing Your Information   © 2012 by Bedford/St. Martin's   47
Follow three guidelines for organizing information
     from more important to less important:

  • Provide signposts.
  • Explain why one point is more important than
    another.
  • Consider using graphics to complement the
    text.




       Chapter 7. Organizing Your Information   © 2012 by Bedford/St. Martin's   48
Follow these four guidelines for organizing
 information by comparison and contrast:

 • Establish criteria for the comparison and
   contrast.
 • Evaluate each item according to the criteria
   you have established.
 • Organize the discussion.
 • Consider using graphics to complement the
   text.

      Chapter 7. Organizing Your Information   © 2012 by Bedford/St. Martin's   49
Follow these six guidelines for organizing
 information by classification or partition:

• Choose a basis of classification or partition that fits
  your audience and purpose.
• Use only one basis of classification or partition at a
  time.
• Avoid overlap.
• Be inclusive.
• Arrange the categories in a logical sequence.
• Consider using graphics to complement the text.

      Chapter 7. Organizing Your Information   © 2012 by Bedford/St. Martin's   50
An example of information
       organized by partition




                                                                          Source: Canon, 2010
                                                                          <www.usa-
                                                                          canon.com/cusa/cons
                                                                          umer/products/camera
                                                                          s/digital_cameras/pow
                                                                          ershot_sx210_is#Box
                                                                          Content>.




Chapter 7. Organizing Your Information   © 2012 by Bedford/St. Martin's                      51
Follow these five guidelines for organizing
information by problem-methods-solution:

 • In describing the problem, be clear and specific.
 • In describing your methods, help your readers
   understand what you did and why you did it that
   way.
 • In describing the solution, don’t overstate.
 • Choose a logical sequence.
 • Consider using graphics to complement the text.

       Chapter 7. Organizing Your Information   © 2012 by Bedford/St. Martin's   52
Follow these four guidelines for
organizing information by cause and effect:

 • Explain your reasoning.
 • Avoid overstating your argument.
 • Avoid logical fallacies.
 • Consider using graphics to complement the
   text.



      Chapter 7. Organizing Your Information   © 2012 by Bedford/St. Martin's   53
Writing Proposals




Chapter 5. Analyzing Your Audience and Purpose   ©
2012 by Bedford/St. Martin's
Writing a proposal requires seven steps:

• Analyze your audience.
• Analyze your purpose.
• Gather information about your subject.
• Choose the appropriate type of proposal.
• Draft the proposal.
• Format the proposal.
• Revise, edit, proofread, and submit the proposal.
        Chapter 16. Writing Proposals   © 2012 by Bedford/St. Martin's   55
The logistics of proposals




Chapter 16. Writing Proposals   © 2012 by Bedford/St. Martin's   56
Solicited and unsolicited
 proposals respond to different needs:

• Solicited proposals are sent in response to an
  information for bid (IFB) or a request for
  proposal (RFP).
• Unsolicited proposals are submitted by a
  supplier who believes that the prospective
  customer has a need for goods or services.



        Chapter 16. Writing Proposals   © 2012 by Bedford/St. Martin's   57
Proposals lead to two kinds of deliverables:

 • research
 • goods and services




        Chapter 16. Writing Proposals   © 2012 by Bedford/St. Martin's   58
A successful proposal
        is a persuasive argument:

• Show that you understand your readers’
  needs.
• Show that you have decided what you plan to
  do and that you are able to do it.
• Show that you are a professional and that you
  are committed to fulfilling your promises.



       Chapter 16. Writing Proposals   © 2012 by Bedford/St. Martin's   59
Follow these six suggestions
  when writing international proposals:

• Understand that what makes an argument
  persuasive can differ from one culture to another.
• Budget enough time for translating.
• Use simple graphics, with captions.
• Write short sentences, using common vocabulary.
• Use local conventions regarding punctuation,
  spelling, and mechanics.
• Ask if the prospective customer will do a read-
  through.
        Chapter 16. Writing Proposals   © 2012 by Bedford/St. Martin's   60
Follow these four guidelines
 to demonstrate your professionalism:

• Describe your credentials and work history.
• Provide your work schedule.
• Describe your quality-control measures.
• Include your budget.




       Chapter 16. Writing Proposals   © 2012 by Bedford/St. Martin's   61
Avoid these four
      common dishonest practices:
• saying that certain qualified people will
  participate in the project, even though they will
  not
• saying that the project will be finished by a
  certain date, even though it will not
• saying that the deliverable will have certain
  characteristics, even though it will not
• saying that the project will be completed under
  budget, even though it will not

        Chapter 16. Writing Proposals   © 2012 by Bedford/St. Martin's   62
There are three reasons
        to write honest proposals:

• to avoid serious legal trouble stemming from
  breach-of-contract suits
• to avoid acquiring a bad reputation, thus
  ruining your business
• to do the right thing




       Chapter 16. Writing Proposals   © 2012 by Bedford/St. Martin's   63
To follow through on a proposal,
you need three categories of resources:

• personnel
• facilities
• equipment




       Chapter 16. Writing Proposals   © 2012 by Bedford/St. Martin's   64
A typical proposal includes six sections:

• summary
• introduction
• proposed program
• qualifications and experience
• budget
• appendixes

       Chapter 16. Writing Proposals   © 2012 by Bedford/St. Martin's   65
An introduction answers seven questions:

•What is the problem or opportunity?
•What is the purpose of the proposal?
•What is the background of the problem or opportunity?
•What are your sources of information?
•What is the scope of the proposal?
•What is the organization of the proposal?
•What key terms will you use in the proposal?


        Chapter 16. Writing Proposals   © 2012 by Bedford/St. Martin's   66
Task schedules are
    presented in one of three formats:

• table
• bar chart or Gantt chart
• network diagram




        Chapter 16. Writing Proposals   © 2012 by Bedford/St. Martin's   67
An example of a task schedule as a table




       Chapter 16. Writing Proposals   © 2012 by Bedford/St. Martin's   68
An example of a task
    schedule as a bar chart




Chapter 16. Writing Proposals   © 2012 by Bedford/St. Martin's   69
An example of a task
       schedule as a network diagram




A network diagram provides more useful information than either a
table or a bar chart.

           Chapter 16. Writing Proposals   © 2012 by Bedford/St. Martin's   70
There are several techniques
       for evaluating completed work:

•   quantitative evaluations
•   qualitative evaluations
•   formative evaluations
•   summative evaluations




         Chapter 16. Writing Proposals   © 2012 by Bedford/St. Martin's   71
Writing Definitions, Descriptions,
              Instructions




Chapter 5. Analyzing Your Audience and Purpose   ©
2012 by Bedford/St. Martin's
What are definitions,
           descriptions, and instructions?

• A definition is typically a brief explanation of
  an item or concept using words and
  (sometimes) graphics.
• A description is typically a longer explanation,
  usually accompanied by graphics, of an
  object, mechanism, or process.
• A set of instructions is a kind of process
  description intended to enable a person to
  carry out a task.
 Chapter 20. Writing Definitions, Descriptions, and Instructions   © 2012 by Bedford/St. Martin's   73
Definitions have two main uses:

• Definitions clarify a description of a new
  development or a new technology in a
  technical field.
• Definitions help specialists communicate with
  less knowledgeable readers.




 Chapter 20. Writing Definitions, Descriptions, and Instructions   © 2012 by Bedford/St. Martin's   74
Use these four strategies when defining
terms for readers from another culture:

• Add a glossary (a list of definitions).
• Use Simplified English and easily
  recognizable terms in definitions.
• Pay close attention to key terms.
• Use graphics to help readers understand a
  term or concept.


 Chapter 20. Writing Definitions, Descriptions, and Instructions   © 2012 by Bedford/St. Martin's   75
There are three types of definitions:

• parenthetical
• sentence
• extended




 Chapter 20. Writing Definitions, Descriptions, and Instructions   © 2012 by Bedford/St. Martin's   76
Sentence definitions follow a typical pattern:


 Item = category + distinguishing characteristics




   Chapter 20. Writing Definitions, Descriptions, and Instructions   © 2012 by Bedford/St. Martin's   77
Follow these four guidelines to
    write effective sentence definitions:

•Be specific in stating the category and the
distinguishing characteristics.
•Don’t describe a specific item if you are defining a
general class of items.
•Avoid writing circular definitions.
•Be sure the category contains a noun or a noun phrase
rather than a phrase beginning with when, what, or
where.


 Chapter 20. Writing Definitions, Descriptions, and Instructions   © 2012 by Bedford/St. Martin's   78
Eight techniques are
             used in extended definitions:
• graphics
• examples
• partition
• principle of operation
• comparison and contrast
• analogy
• negation
• etymology

 Chapter 20. Writing Definitions, Descriptions, and Instructions   © 2012 by Bedford/St. Martin's   79
Decide where to place the definition:

• in the text
• in a marginal gloss
• in a hyperlink
• in a footnote
• in a glossary
• in an appendix



 Chapter 20. Writing Definitions, Descriptions, and Instructions   © 2012 by Bedford/St. Martin's   80
Descriptions are verbal and visual
         representations of three items:

• objects
• mechanisms
• processes




   Chapter 20. Writing Definitions, Descriptions, and Instructions   © 2012 by Bedford/St. Martin's   81
Follow these four principles
                when writing descriptions:

• Clearly indicate the nature and scope of the
  description.
• Introduce the description clearly.
• Provide appropriate detail.
• Conclude the description.



 Chapter 20. Writing Definitions, Descriptions, and Instructions   © 2012 by Bedford/St. Martin's   82
Answer these five questions to introduce
  object or mechanism descriptions:

• What is the item?
• What is the function of the item?
• What does the item look like?
• How does the item work?
• What are the principal parts of the item?



 Chapter 20. Writing Definitions, Descriptions, and Instructions   © 2012 by Bedford/St. Martin's   83
Answer these six questions to
          introduce process descriptions:

• What is the process?
• What is the function of the process?
• Where and when does the process take place?
• Who or what performs the process?
• How does the process work?
• What are the principal steps of the process?



 Chapter 20. Writing Definitions, Descriptions, and Instructions   © 2012 by Bedford/St. Martin's   84
Provide appropriate detail in
 mechanism and object descriptions:

• Choose an appropriate organizational
  principle:
     functional
     spatial
• Use graphics.



Chapter 20. Writing Definitions, Descriptions, and Instructions   © 2012 by Bedford/St. Martin's   85
Provide appropriate detail
                   in process descriptions:

• Structure the step-by-step description
  chronologically.
• Explain causal relationships among steps.
• Use the present tense.
• Use graphics.



 Chapter 20. Writing Definitions, Descriptions, and Instructions   © 2012 by Bedford/St. Martin's   86
An example of a process
         description based on a graphic




Chapter 20. Writing Definitions, Descriptions, and Instructions   © 2012 by Bedford/St. Martin's   87
Consider five questions
    when designing a set of instructions:

• What are your reader’s expectations?
• Do you need to create more than one set of
  instructions for different audiences?
• What languages should you use?
• Will readers be anxious about the information?
• Will the environment in which the instructions
  are read affect the document design?

   Chapter 20. Writing Definitions, Descriptions, and Instructions   © 2012 by Bedford/St. Martin's   88
Follow these two guidelines
        to design clear, attractive pages:

• Create an open, airy design.
• Clearly relate the graphics to the text.




 Chapter 20. Writing Definitions, Descriptions, and Instructions   © 2012 by Bedford/St. Martin's   89
Examples of cluttered
                        and attractive page designs




Source: Slide-                                                                                         Source: Anthro,
Lok, 2005                                                                                              2005
<www.slide-                                                                                            <www.anthro.com/
lok.com/                                                                                               assemblyinstructio
assembly/P246                                                                                          ns/300-5237-
8/P2468.pdf>.                                                                                          00.pdf>.




            Chapter 20. Writing Definitions, Descriptions, and Instructions   © 2012 by Bedford/St. Martin's          90
Understand the four signal words
      used in manuals and instructions:

• Danger indicates an immediate and serious hazard
  that will likely be fatal.
• Warning indicates the potential for serious injury or
  death or serious damage to equipment.
• Caution indicates the potential for anything from
  moderate injury to serious equipment damage or
  destruction.
• Note indicates a tip or suggestion to help readers
  carry out the procedure successfully

 Chapter 20. Writing Definitions, Descriptions, and Instructions   © 2012 by Bedford/St. Martin's   91
An example of a safety label




Chapter 20. Writing Definitions, Descriptions, and Instructions   © 2012 by Bedford/St. Martin's   92
A typical set of instructions
            includes these four elements:

• title
• general introduction
• step-by-step instructions
• conclusion




 Chapter 20. Writing Definitions, Descriptions, and Instructions   © 2012 by Bedford/St. Martin's   93
Write effective titles for instructions:

Effective titles:
• How-to. “How to Install the J112 Shock
  Absorber”
• Gerund. “Installing the J112 Shock Absorber”

Ineffective titles:
Noun strings. “J112 Shock Absorber Installation
  Instructions”

 Chapter 20. Writing Definitions, Descriptions, and Instructions   © 2012 by Bedford/St. Martin's   94
Consider answering these six questions
when drafting introductions for instructions:

 • Who should carry out this task?
 • Why should the reader carry out this task?
 • When should the reader carry out this task?
 • What safety measures or other concerns should
   the reader understand?
 • What items will the reader need?
 • How long will the task take?

  Chapter 20. Writing Definitions, Descriptions, and Instructions   © 2012 by Bedford/St. Martin's   95
Follow these six guidelines
     when drafting steps in instructions:

• Number the instructions.
• Present the right amount of information in each
  step.
• Use the imperative mood.
• Don’t confuse steps and feedback statements.
• Include graphics.
• Do not omit articles (a, an, the) to save space.

 Chapter 20. Writing Definitions, Descriptions, and Instructions   © 2012 by Bedford/St. Martin's   96
Typical elements in the
                     front matter of a manual:

•    introduction or preface
•    overview of the contents
•    conventions section
•    “where to get help” section
•    list of trademarks




Chapter 20. Writing Definitions, Descriptions, and Instructions   © 2012 by Bedford/St. Martin's   25
Typical elements in the
                   back matter of a manual:

• set of specifications
• list of safety regulations and industry
  standards
• tips on maintenance and servicing
• copyright page
• index
• glossary

Chapter 20. Writing Definitions, Descriptions, and Instructions   © 2012 by Bedford/St. Martin's   26
Consider these three questions when
writing instructions for multicultural readers:

  • In what language should the information be
    written?
  • Do the text or graphics need to be modified?
  • What is the reader’s technological
    infrastructure?




   Chapter 20. Writing Definitions, Descriptions, and Instructions   © 2012 by Bedford/St. Martin's   99

More Related Content

Similar to Week 02

BRM 2-Formulating and clarifying Research Topic Lecture 3.ppt
BRM 2-Formulating and clarifying Research Topic  Lecture 3.pptBRM 2-Formulating and clarifying Research Topic  Lecture 3.ppt
BRM 2-Formulating and clarifying Research Topic Lecture 3.pptMaryamLaraib
 
Chapter 2-research2
Chapter 2-research2Chapter 2-research2
Chapter 2-research2Eaglefly Fly
 
Chapter 3: Writing Technical Documents
Chapter 3: Writing Technical DocumentsChapter 3: Writing Technical Documents
Chapter 3: Writing Technical DocumentsRanda Jobe
 
Research Problem
Research ProblemResearch Problem
Research ProblemSajid Nasar
 
Academic Seminar My Approach To PhD Dissertation
Academic Seminar My Approach To PhD DissertationAcademic Seminar My Approach To PhD Dissertation
Academic Seminar My Approach To PhD DissertationAmy Roman
 
Business Research Methods Notes.pdf
Business Research Methods Notes.pdfBusiness Research Methods Notes.pdf
Business Research Methods Notes.pdfBilalAhmed717
 
Principles and practice of searching the literature updated detail_2012_for_h...
Principles and practice of searching the literature updated detail_2012_for_h...Principles and practice of searching the literature updated detail_2012_for_h...
Principles and practice of searching the literature updated detail_2012_for_h...James Little
 
Greener S. - Business Research Methods (2008).pdf
Greener S. - Business Research Methods (2008).pdfGreener S. - Business Research Methods (2008).pdf
Greener S. - Business Research Methods (2008).pdfarpadsipos
 
chpter 2 saunder for next week.pptx
chpter 2 saunder for next week.pptxchpter 2 saunder for next week.pptx
chpter 2 saunder for next week.pptxSaleemBhatti5
 
Data Collection Methods
Data Collection MethodsData Collection Methods
Data Collection MethodsEstherMakori1
 
Planning to raise Māori student achievement
 Planning to raise Māori student achievement Planning to raise Māori student achievement
Planning to raise Māori student achievementbradnaml
 

Similar to Week 02 (20)

Ch04 slides
Ch04 slidesCh04 slides
Ch04 slides
 
Ch16 slides
Ch16 slidesCh16 slides
Ch16 slides
 
BRM 2-Formulating and clarifying Research Topic Lecture 3.ppt
BRM 2-Formulating and clarifying Research Topic  Lecture 3.pptBRM 2-Formulating and clarifying Research Topic  Lecture 3.ppt
BRM 2-Formulating and clarifying Research Topic Lecture 3.ppt
 
Ch22 slides
Ch22 slidesCh22 slides
Ch22 slides
 
Ch15 slides
Ch15 slidesCh15 slides
Ch15 slides
 
Ch03 slides
Ch03 slidesCh03 slides
Ch03 slides
 
Chapter 2-research2
Chapter 2-research2Chapter 2-research2
Chapter 2-research2
 
Chapter 3: Writing Technical Documents
Chapter 3: Writing Technical DocumentsChapter 3: Writing Technical Documents
Chapter 3: Writing Technical Documents
 
Daily chores.ppt
Daily chores.pptDaily chores.ppt
Daily chores.ppt
 
Audience
AudienceAudience
Audience
 
Research Problem
Research ProblemResearch Problem
Research Problem
 
Academic Seminar My Approach To PhD Dissertation
Academic Seminar My Approach To PhD DissertationAcademic Seminar My Approach To PhD Dissertation
Academic Seminar My Approach To PhD Dissertation
 
Business Research Methods Notes.pdf
Business Research Methods Notes.pdfBusiness Research Methods Notes.pdf
Business Research Methods Notes.pdf
 
Research from ideas to_publication
Research from ideas to_publicationResearch from ideas to_publication
Research from ideas to_publication
 
Principles and practice of searching the literature updated detail_2012_for_h...
Principles and practice of searching the literature updated detail_2012_for_h...Principles and practice of searching the literature updated detail_2012_for_h...
Principles and practice of searching the literature updated detail_2012_for_h...
 
Art of Richness.ppt
Art of Richness.pptArt of Richness.ppt
Art of Richness.ppt
 
Greener S. - Business Research Methods (2008).pdf
Greener S. - Business Research Methods (2008).pdfGreener S. - Business Research Methods (2008).pdf
Greener S. - Business Research Methods (2008).pdf
 
chpter 2 saunder for next week.pptx
chpter 2 saunder for next week.pptxchpter 2 saunder for next week.pptx
chpter 2 saunder for next week.pptx
 
Data Collection Methods
Data Collection MethodsData Collection Methods
Data Collection Methods
 
Planning to raise Māori student achievement
 Planning to raise Māori student achievement Planning to raise Māori student achievement
Planning to raise Māori student achievement
 

More from Aimee Kendall Roundtree (20)

Eng 6331 Geevers 5 8
Eng 6331 Geevers 5 8Eng 6331 Geevers 5 8
Eng 6331 Geevers 5 8
 
6331 Module 1
6331 Module 16331 Module 1
6331 Module 1
 
ENG 4340 Weeks 13 and 14
ENG 4340 Weeks 13 and 14ENG 4340 Weeks 13 and 14
ENG 4340 Weeks 13 and 14
 
4340 week-12
4340 week-124340 week-12
4340 week-12
 
ENG 4340 Week 11
ENG 4340 Week 11ENG 4340 Week 11
ENG 4340 Week 11
 
ENG 4340 Week 10
ENG 4340 Week 10ENG 4340 Week 10
ENG 4340 Week 10
 
ENG 6324 Slide Presentation Week 9
ENG 6324 Slide Presentation Week 9ENG 6324 Slide Presentation Week 9
ENG 6324 Slide Presentation Week 9
 
Slide Presentation Week 9
Slide Presentation Week 9Slide Presentation Week 9
Slide Presentation Week 9
 
4340 week-8
4340 week-84340 week-8
4340 week-8
 
ENG 4340 Week 7
ENG 4340 Week 7ENG 4340 Week 7
ENG 4340 Week 7
 
Week 5 4340
Week 5 4340Week 5 4340
Week 5 4340
 
SMM Week 4
SMM Week 4SMM Week 4
SMM Week 4
 
Social Media Marketing Week 3
Social Media Marketing Week 3Social Media Marketing Week 3
Social Media Marketing Week 3
 
Dennis and Defleur Ch. 13
Dennis and Defleur Ch. 13Dennis and Defleur Ch. 13
Dennis and Defleur Ch. 13
 
Dennis and Defleur Ch. 11 and 12
Dennis and Defleur Ch. 11 and 12Dennis and Defleur Ch. 11 and 12
Dennis and Defleur Ch. 11 and 12
 
Dennis & Defleur Chapter 9
Dennis & Defleur Chapter 9Dennis & Defleur Chapter 9
Dennis & Defleur Chapter 9
 
Dennis & Defleur Ch. 5
Dennis & Defleur Ch. 5Dennis & Defleur Ch. 5
Dennis & Defleur Ch. 5
 
SMM 01
SMM 01SMM 01
SMM 01
 
ENG 6328 Week 1
ENG 6328 Week 1ENG 6328 Week 1
ENG 6328 Week 1
 
Unit 4 Grantwriting
Unit 4 GrantwritingUnit 4 Grantwriting
Unit 4 Grantwriting
 

Week 02

  • 1. Week 2: Audiences, Research, Organization, Proposals, Definitions & Descriptions ENG 3302 Winter Roundtree Chapter 5. Analyzing Your Audience and Purpose © 2012 by Bedford/St. Martin's
  • 2. Table of Contents Analyzing Your Audience and Purpose…….…slide 3 Researching Your Subject…………………...….slide 16 Organizing Your Information…………………....slide 39 Writing Proposals…………………………….…..slide 54 Writing Definitions, Descriptions Instructions….slide 72 Chapter 5. Analyzing Your Audience and Purpose © 2012 by Bedford/St. Martin's
  • 3. Analyzing Your Audience and Purpose Chapter 5. Analyzing Your Audience and Purpose © 2012 by Bedford/St. Martin's
  • 4. Determine four important characteristics of your audience: • Who are your readers? • Why is your audience reading your document? • What are your readers’ attitudes and expectations? • How will your readers use your document? Chapter 5. Analyzing Your Audience and Purpose © 2012 by Bedford/St. Martin's 4
  • 5. Consider six factors about your most important readers: • the reader’s education • the reader’s professional experience • the reader’s job responsibility • the reader’s personal characteristics • the reader’s personal preferences • the reader’s cultural characteristics Chapter 5. Analyzing Your Audience and Purpose © 2012 by Bedford/St. Martin's 5
  • 6. Classify your readers into three categories: • a primary audience of people who will use your document in carrying out their jobs • a secondary audience of people who need to stay aware of developments in the organization but who will not directly act on or respond to your document • a tertiary audience of people who might take an interest in the subject of the document Chapter 5. Analyzing Your Audience and Purpose © 2012 by Bedford/St. Martin's 6
  • 7. Your readers have attitudes and expectations: • attitudes toward you • attitudes toward the subject • expectations about the document Chapter 5. Analyzing Your Audience and Purpose © 2012 by Bedford/St. Martin's 7
  • 8. Why and how will your readers use your document? • Why is the reader reading your document? • How will the reader read your document? • What is the reader’s reading skill level? • What is the physical environment in which the reader will read your document? Chapter 5. Analyzing Your Audience and Purpose © 2012 by Bedford/St. Martin's 8
  • 9. Learn about your audience: • Determine what you already know about your audience. • Interview people. • Read about your audience online. • Search social media for documents your audience has written. Chapter 5. Analyzing Your Audience and Purpose © 2012 by Bedford/St. Martin's 9
  • 10. Understand seven cultural variables that lie “on the surface”: • political • economic • social • religious • educational • technological • linguistic Chapter 5. Analyzing Your Audience and Purpose © 2012 by Bedford/St. Martin's 10
  • 11. Understand six cultural variables that lie “beneath the surface”: • focus on individuals or groups • distance between business life and private life • distance between ranks • nature of truth • need to spell out details • attitudes toward uncertainty Chapter 5. Analyzing Your Audience and Purpose © 2012 by Bedford/St. Martin's 11
  • 12. Consider four points about cultural variables “beneath the surface”: • Each variable represents a spectrum of attitudes. • The six variables do not line up in a clear pattern. • Different organizations within the same culture can vary greatly. • An organization’s cultural attitudes are fluid, not static. Chapter 5. Analyzing Your Audience and Purpose © 2012 by Bedford/St. Martin's 12
  • 13. Use these eight strategies when writing for readers from other cultures: • Limit your vocabulary. • Keep sentences short. • Define abbreviations and acronyms in a glossary. • Avoid jargon unless you know your readers are familiar with it. Chapter 5. Analyzing Your Audience and Purpose © 2012 by Bedford/St. Martin's 13
  • 14. Use these eight strategies when writing for readers from other cultures (cont.): • Avoid idioms and slang. • Use the active voice whenever possible. • Be careful with graphics. • Be sure someone from the target culture reviews the document. Chapter 5. Analyzing Your Audience and Purpose © 2012 by Bedford/St. Martin's
  • 15. Determine your purpose: Ask yourself: • What do I want this document to accomplish? • What do I want readers to know or believe? • What do I want readers to do? Chapter 5. Analyzing Your Audience and Purpose © 2012 by Bedford/St. Martin's 15
  • 16. Researching Your Subject Chapter 5. Analyzing Your Audience and Purpose © 2012 by Bedford/St. Martin's
  • 17. Understand the differences between academic and workplace research: • In academic research, your goal is to find information that will help you answer a scholarly question. • In workplace research, your goal is to find information that will help you answer a practical question, usually one that involves the organization for which you work. Chapter 6. Researching Your Subject © 2012 by Bedford/St. Martin's 17
  • 18. The research process consists of 12 steps: • Analyze your audience. • Analyze your purpose. • Analyze your subject. • Visualize the deliverable. • Work out a schedule and a budget. • Determine what information will need to be part of that deliverable. Chapter 6. Researching Your Subject © 2012 by Bedford/St. Martin's 18
  • 19. The research process consists of 12 steps (cont.): • Determine what information you still need to acquire. • Create questions you need to answer in your deliverable. • Conduct secondary research. • Conduct primary research. • Evaluate your information. • Do more research. Chapter 6. Researching Your Subject © 2012 by Bedford/St. Martin's 19
  • 20. Choose appropriate research methods: • What types of research media might you use? • What types of research tools might you use? • What types of primary research might you conduct? Chapter 6. Researching Your Subject © 2012 by Bedford/St. Martin's 20
  • 21. Follow three guidelines when researching a topic: • Be persistent. • Record your data carefully. • Triangulate your research methods. Chapter 6. Researching Your Subject © 2012 by Bedford/St. Martin's 21
  • 22. Know the four types of information media: • print • online databases • Web sites • social media Chapter 6. Researching Your Subject © 2012 by Bedford/St. Martin's 22
  • 23. Know how to use six basic research tools: • online catalogs • reference works • periodical indexes • newspaper indexes • abstract services • government information Chapter 6. Researching Your Subject © 2012 by Bedford/St. Martin's 23
  • 24. Understand these five forms of social media: • discussion boards • wikis • blogs • tagged content • RSS feeds Chapter 6. Researching Your Subject © 2012 by Bedford/St. Martin's 24
  • 25. Look for information that is . . . • accurate • unbiased • comprehensive • appropriately technical • current • clear Chapter 6. Researching Your Subject © 2012 by Bedford/St. Martin's 25
  • 26. When evaluating print and online sources, examine these five factors: • authorship • publisher • knowledge of the literature • accuracy and verifiability of the information • timeliness Chapter 6. Researching Your Subject © 2012 by Bedford/St. Martin's 26
  • 27. Understand the seven techniques of primary research: • observations and demonstrations • inspections • experiments • field research • interviews • inquiries • questionnaires Chapter 6. Researching Your Subject © 2012 by Bedford/St. Martin's 27
  • 28. Conducting an experiment consists of four phases: • establishing a hypothesis • testing the hypothesis • analyzing the data • reporting the data Chapter 6. Researching Your Subject © 2012 by Bedford/St. Martin's 28
  • 29. Field research is vulnerable to two common problems: • the effect of the experiment on the behavior you are studying • bias in the recording and analysis of the data Chapter 6. Researching Your Subject © 2012 by Bedford/St. Martin's 29
  • 30. Consider three factors when choosing a person to interview: • What questions do you want to answer? • Who could provide the information you need? • Is the person willing to be interviewed? Chapter 6. Researching Your Subject © 2012 by Bedford/St. Martin's 30
  • 31. Prepare for the interview: • Do your homework. • Prepare good questions. • Check your equipment. Chapter 6. Researching Your Subject © 2012 by Bedford/St. Martin's 31
  • 32. Begin the interview: • Arrive on time. • Thank the respondent. • State the subject and purpose of the interview. • If you want to record the interview, ask permission. Chapter 6. Researching Your Subject © 2012 by Bedford/St. Martin's 32
  • 33. Conduct the interview: • Take notes. • Start with prepared questions. • Be prepared to ask follow-up questions. • Be prepared to get the interview back on track. Chapter 6. Researching Your Subject © 2012 by Bedford/St. Martin's 33
  • 34. Conclude the interview: • Thank the respondent. • Ask for a follow-up interview. • Ask for permission to quote the respondent. Chapter 6. Researching Your Subject © 2012 by Bedford/St. Martin's 34
  • 35. After the interview, do two tasks: • Write down the important information while the interview is fresh in your mind. • Send a brief thank-you note. Chapter 6. Researching Your Subject © 2012 by Bedford/St. Martin's 35
  • 36. Questionnaires are vulnerable to three problems: • Some of the questions will misfire. • You won’t obtain as many responses as you want. • You cannot be sure the respondents are representative. Chapter 6. Researching Your Subject © 2012 by Bedford/St. Martin's 36
  • 37. Using questionnaires effectively calls for four steps: • Ask effective questions. • Test the questionnaire. • Administer the questionnaire. • Present questionnaire data in your document. Chapter 6. Researching Your Subject © 2012 by Bedford/St. Martin's 37
  • 38. Understand the six common types of questions: • multiple choice • Likert scale • semantic differentials • ranking • short answer • short essay Chapter 6. Researching Your Subject © 2012 by Bedford/St. Martin's 38
  • 39. Organizing Your Information Chapter 5. Analyzing Your Audience and Purpose © 2012 by Bedford/St. Martin's
  • 40. Understand three principles for organizing technical information: • Analyze your audience and purpose. • Use conventional patterns of organization. • Display your organizational pattern prominently in the document. Chapter 7. Organizing Your Information © 2012 by Bedford/St. Martin's 40
  • 41. Ask four questions when you study documents from other cultures: • Does the text follow expected organizational patterns? • Do the introductions and conclusions present the kind of information you would expect? • Does the text appear to be organized linearly? • Does the text use headings? If so, does it use more than one level? Chapter 7. Organizing Your Information © 2012 by Bedford/St. Martin's 41
  • 42. Display your organizational pattern prominently: • Create a detailed table of contents. • Use headings liberally. • Use topic sentences at the beginnings of your paragraphs. Chapter 7. Organizing Your Information © 2012 by Bedford/St. Martin's 42
  • 43. Understand eight typical patterns of organization: • chronological • spatial • general to specific • more important to less important • comparison and contrast • classification and partition • problem-methods-solution • cause and effect Chapter 7. Organizing Your Information © 2012 by Bedford/St. Martin's 43
  • 44. Follow these three guidelines for organizing information chronologically: • Provide signposts. • Consider using graphics to complement the text. • Analyze events where appropriate. Chapter 7. Organizing Your Information © 2012 by Bedford/St. Martin's 44
  • 45. Follow these three guidelines for organizing information spatially: • Provide signposts. • Consider using graphics to complement the text. • Analyze events where appropriate. Chapter 7. Organizing Your Information © 2012 by Bedford/St. Martin's 45
  • 46. An example of information organized spatially Source: Metropolitan Museum of Art, 2010 <www.metmuseum. org/toah/world- regions/#/09/World- Map>. Chapter 7. Organizing Your Information © 2012 by Bedford/St. Martin's 46
  • 47. Follow these two guidelines for organizing information from general to specific: • Provide signposts. • Consider using graphics to complement the text. Chapter 7. Organizing Your Information © 2012 by Bedford/St. Martin's 47
  • 48. Follow three guidelines for organizing information from more important to less important: • Provide signposts. • Explain why one point is more important than another. • Consider using graphics to complement the text. Chapter 7. Organizing Your Information © 2012 by Bedford/St. Martin's 48
  • 49. Follow these four guidelines for organizing information by comparison and contrast: • Establish criteria for the comparison and contrast. • Evaluate each item according to the criteria you have established. • Organize the discussion. • Consider using graphics to complement the text. Chapter 7. Organizing Your Information © 2012 by Bedford/St. Martin's 49
  • 50. Follow these six guidelines for organizing information by classification or partition: • Choose a basis of classification or partition that fits your audience and purpose. • Use only one basis of classification or partition at a time. • Avoid overlap. • Be inclusive. • Arrange the categories in a logical sequence. • Consider using graphics to complement the text. Chapter 7. Organizing Your Information © 2012 by Bedford/St. Martin's 50
  • 51. An example of information organized by partition Source: Canon, 2010 <www.usa- canon.com/cusa/cons umer/products/camera s/digital_cameras/pow ershot_sx210_is#Box Content>. Chapter 7. Organizing Your Information © 2012 by Bedford/St. Martin's 51
  • 52. Follow these five guidelines for organizing information by problem-methods-solution: • In describing the problem, be clear and specific. • In describing your methods, help your readers understand what you did and why you did it that way. • In describing the solution, don’t overstate. • Choose a logical sequence. • Consider using graphics to complement the text. Chapter 7. Organizing Your Information © 2012 by Bedford/St. Martin's 52
  • 53. Follow these four guidelines for organizing information by cause and effect: • Explain your reasoning. • Avoid overstating your argument. • Avoid logical fallacies. • Consider using graphics to complement the text. Chapter 7. Organizing Your Information © 2012 by Bedford/St. Martin's 53
  • 54. Writing Proposals Chapter 5. Analyzing Your Audience and Purpose © 2012 by Bedford/St. Martin's
  • 55. Writing a proposal requires seven steps: • Analyze your audience. • Analyze your purpose. • Gather information about your subject. • Choose the appropriate type of proposal. • Draft the proposal. • Format the proposal. • Revise, edit, proofread, and submit the proposal. Chapter 16. Writing Proposals © 2012 by Bedford/St. Martin's 55
  • 56. The logistics of proposals Chapter 16. Writing Proposals © 2012 by Bedford/St. Martin's 56
  • 57. Solicited and unsolicited proposals respond to different needs: • Solicited proposals are sent in response to an information for bid (IFB) or a request for proposal (RFP). • Unsolicited proposals are submitted by a supplier who believes that the prospective customer has a need for goods or services. Chapter 16. Writing Proposals © 2012 by Bedford/St. Martin's 57
  • 58. Proposals lead to two kinds of deliverables: • research • goods and services Chapter 16. Writing Proposals © 2012 by Bedford/St. Martin's 58
  • 59. A successful proposal is a persuasive argument: • Show that you understand your readers’ needs. • Show that you have decided what you plan to do and that you are able to do it. • Show that you are a professional and that you are committed to fulfilling your promises. Chapter 16. Writing Proposals © 2012 by Bedford/St. Martin's 59
  • 60. Follow these six suggestions when writing international proposals: • Understand that what makes an argument persuasive can differ from one culture to another. • Budget enough time for translating. • Use simple graphics, with captions. • Write short sentences, using common vocabulary. • Use local conventions regarding punctuation, spelling, and mechanics. • Ask if the prospective customer will do a read- through. Chapter 16. Writing Proposals © 2012 by Bedford/St. Martin's 60
  • 61. Follow these four guidelines to demonstrate your professionalism: • Describe your credentials and work history. • Provide your work schedule. • Describe your quality-control measures. • Include your budget. Chapter 16. Writing Proposals © 2012 by Bedford/St. Martin's 61
  • 62. Avoid these four common dishonest practices: • saying that certain qualified people will participate in the project, even though they will not • saying that the project will be finished by a certain date, even though it will not • saying that the deliverable will have certain characteristics, even though it will not • saying that the project will be completed under budget, even though it will not Chapter 16. Writing Proposals © 2012 by Bedford/St. Martin's 62
  • 63. There are three reasons to write honest proposals: • to avoid serious legal trouble stemming from breach-of-contract suits • to avoid acquiring a bad reputation, thus ruining your business • to do the right thing Chapter 16. Writing Proposals © 2012 by Bedford/St. Martin's 63
  • 64. To follow through on a proposal, you need three categories of resources: • personnel • facilities • equipment Chapter 16. Writing Proposals © 2012 by Bedford/St. Martin's 64
  • 65. A typical proposal includes six sections: • summary • introduction • proposed program • qualifications and experience • budget • appendixes Chapter 16. Writing Proposals © 2012 by Bedford/St. Martin's 65
  • 66. An introduction answers seven questions: •What is the problem or opportunity? •What is the purpose of the proposal? •What is the background of the problem or opportunity? •What are your sources of information? •What is the scope of the proposal? •What is the organization of the proposal? •What key terms will you use in the proposal? Chapter 16. Writing Proposals © 2012 by Bedford/St. Martin's 66
  • 67. Task schedules are presented in one of three formats: • table • bar chart or Gantt chart • network diagram Chapter 16. Writing Proposals © 2012 by Bedford/St. Martin's 67
  • 68. An example of a task schedule as a table Chapter 16. Writing Proposals © 2012 by Bedford/St. Martin's 68
  • 69. An example of a task schedule as a bar chart Chapter 16. Writing Proposals © 2012 by Bedford/St. Martin's 69
  • 70. An example of a task schedule as a network diagram A network diagram provides more useful information than either a table or a bar chart. Chapter 16. Writing Proposals © 2012 by Bedford/St. Martin's 70
  • 71. There are several techniques for evaluating completed work: • quantitative evaluations • qualitative evaluations • formative evaluations • summative evaluations Chapter 16. Writing Proposals © 2012 by Bedford/St. Martin's 71
  • 72. Writing Definitions, Descriptions, Instructions Chapter 5. Analyzing Your Audience and Purpose © 2012 by Bedford/St. Martin's
  • 73. What are definitions, descriptions, and instructions? • A definition is typically a brief explanation of an item or concept using words and (sometimes) graphics. • A description is typically a longer explanation, usually accompanied by graphics, of an object, mechanism, or process. • A set of instructions is a kind of process description intended to enable a person to carry out a task. Chapter 20. Writing Definitions, Descriptions, and Instructions © 2012 by Bedford/St. Martin's 73
  • 74. Definitions have two main uses: • Definitions clarify a description of a new development or a new technology in a technical field. • Definitions help specialists communicate with less knowledgeable readers. Chapter 20. Writing Definitions, Descriptions, and Instructions © 2012 by Bedford/St. Martin's 74
  • 75. Use these four strategies when defining terms for readers from another culture: • Add a glossary (a list of definitions). • Use Simplified English and easily recognizable terms in definitions. • Pay close attention to key terms. • Use graphics to help readers understand a term or concept. Chapter 20. Writing Definitions, Descriptions, and Instructions © 2012 by Bedford/St. Martin's 75
  • 76. There are three types of definitions: • parenthetical • sentence • extended Chapter 20. Writing Definitions, Descriptions, and Instructions © 2012 by Bedford/St. Martin's 76
  • 77. Sentence definitions follow a typical pattern: Item = category + distinguishing characteristics Chapter 20. Writing Definitions, Descriptions, and Instructions © 2012 by Bedford/St. Martin's 77
  • 78. Follow these four guidelines to write effective sentence definitions: •Be specific in stating the category and the distinguishing characteristics. •Don’t describe a specific item if you are defining a general class of items. •Avoid writing circular definitions. •Be sure the category contains a noun or a noun phrase rather than a phrase beginning with when, what, or where. Chapter 20. Writing Definitions, Descriptions, and Instructions © 2012 by Bedford/St. Martin's 78
  • 79. Eight techniques are used in extended definitions: • graphics • examples • partition • principle of operation • comparison and contrast • analogy • negation • etymology Chapter 20. Writing Definitions, Descriptions, and Instructions © 2012 by Bedford/St. Martin's 79
  • 80. Decide where to place the definition: • in the text • in a marginal gloss • in a hyperlink • in a footnote • in a glossary • in an appendix Chapter 20. Writing Definitions, Descriptions, and Instructions © 2012 by Bedford/St. Martin's 80
  • 81. Descriptions are verbal and visual representations of three items: • objects • mechanisms • processes Chapter 20. Writing Definitions, Descriptions, and Instructions © 2012 by Bedford/St. Martin's 81
  • 82. Follow these four principles when writing descriptions: • Clearly indicate the nature and scope of the description. • Introduce the description clearly. • Provide appropriate detail. • Conclude the description. Chapter 20. Writing Definitions, Descriptions, and Instructions © 2012 by Bedford/St. Martin's 82
  • 83. Answer these five questions to introduce object or mechanism descriptions: • What is the item? • What is the function of the item? • What does the item look like? • How does the item work? • What are the principal parts of the item? Chapter 20. Writing Definitions, Descriptions, and Instructions © 2012 by Bedford/St. Martin's 83
  • 84. Answer these six questions to introduce process descriptions: • What is the process? • What is the function of the process? • Where and when does the process take place? • Who or what performs the process? • How does the process work? • What are the principal steps of the process? Chapter 20. Writing Definitions, Descriptions, and Instructions © 2012 by Bedford/St. Martin's 84
  • 85. Provide appropriate detail in mechanism and object descriptions: • Choose an appropriate organizational principle:  functional  spatial • Use graphics. Chapter 20. Writing Definitions, Descriptions, and Instructions © 2012 by Bedford/St. Martin's 85
  • 86. Provide appropriate detail in process descriptions: • Structure the step-by-step description chronologically. • Explain causal relationships among steps. • Use the present tense. • Use graphics. Chapter 20. Writing Definitions, Descriptions, and Instructions © 2012 by Bedford/St. Martin's 86
  • 87. An example of a process description based on a graphic Chapter 20. Writing Definitions, Descriptions, and Instructions © 2012 by Bedford/St. Martin's 87
  • 88. Consider five questions when designing a set of instructions: • What are your reader’s expectations? • Do you need to create more than one set of instructions for different audiences? • What languages should you use? • Will readers be anxious about the information? • Will the environment in which the instructions are read affect the document design? Chapter 20. Writing Definitions, Descriptions, and Instructions © 2012 by Bedford/St. Martin's 88
  • 89. Follow these two guidelines to design clear, attractive pages: • Create an open, airy design. • Clearly relate the graphics to the text. Chapter 20. Writing Definitions, Descriptions, and Instructions © 2012 by Bedford/St. Martin's 89
  • 90. Examples of cluttered and attractive page designs Source: Slide- Source: Anthro, Lok, 2005 2005 <www.slide- <www.anthro.com/ lok.com/ assemblyinstructio assembly/P246 ns/300-5237- 8/P2468.pdf>. 00.pdf>. Chapter 20. Writing Definitions, Descriptions, and Instructions © 2012 by Bedford/St. Martin's 90
  • 91. Understand the four signal words used in manuals and instructions: • Danger indicates an immediate and serious hazard that will likely be fatal. • Warning indicates the potential for serious injury or death or serious damage to equipment. • Caution indicates the potential for anything from moderate injury to serious equipment damage or destruction. • Note indicates a tip or suggestion to help readers carry out the procedure successfully Chapter 20. Writing Definitions, Descriptions, and Instructions © 2012 by Bedford/St. Martin's 91
  • 92. An example of a safety label Chapter 20. Writing Definitions, Descriptions, and Instructions © 2012 by Bedford/St. Martin's 92
  • 93. A typical set of instructions includes these four elements: • title • general introduction • step-by-step instructions • conclusion Chapter 20. Writing Definitions, Descriptions, and Instructions © 2012 by Bedford/St. Martin's 93
  • 94. Write effective titles for instructions: Effective titles: • How-to. “How to Install the J112 Shock Absorber” • Gerund. “Installing the J112 Shock Absorber” Ineffective titles: Noun strings. “J112 Shock Absorber Installation Instructions” Chapter 20. Writing Definitions, Descriptions, and Instructions © 2012 by Bedford/St. Martin's 94
  • 95. Consider answering these six questions when drafting introductions for instructions: • Who should carry out this task? • Why should the reader carry out this task? • When should the reader carry out this task? • What safety measures or other concerns should the reader understand? • What items will the reader need? • How long will the task take? Chapter 20. Writing Definitions, Descriptions, and Instructions © 2012 by Bedford/St. Martin's 95
  • 96. Follow these six guidelines when drafting steps in instructions: • Number the instructions. • Present the right amount of information in each step. • Use the imperative mood. • Don’t confuse steps and feedback statements. • Include graphics. • Do not omit articles (a, an, the) to save space. Chapter 20. Writing Definitions, Descriptions, and Instructions © 2012 by Bedford/St. Martin's 96
  • 97. Typical elements in the front matter of a manual: • introduction or preface • overview of the contents • conventions section • “where to get help” section • list of trademarks Chapter 20. Writing Definitions, Descriptions, and Instructions © 2012 by Bedford/St. Martin's 25
  • 98. Typical elements in the back matter of a manual: • set of specifications • list of safety regulations and industry standards • tips on maintenance and servicing • copyright page • index • glossary Chapter 20. Writing Definitions, Descriptions, and Instructions © 2012 by Bedford/St. Martin's 26
  • 99. Consider these three questions when writing instructions for multicultural readers: • In what language should the information be written? • Do the text or graphics need to be modified? • What is the reader’s technological infrastructure? Chapter 20. Writing Definitions, Descriptions, and Instructions © 2012 by Bedford/St. Martin's 99