Comm 1009 Week Five 2014

  • Upload
    waysen

  • View
    8

  • Download
    0

Embed Size (px)

DESCRIPTION

Chapter 7 Notes John m lannon & don klepp Technical Communication

Citation preview

  • Comm. 1009: Week 5

    Process Descriptions

  • Description commonalities

    Technical description are defined here as everything from expanded definitions to full-fledged multi-page descriptions of an item, concept, or phenomenon.

    Process descriptions here include analyses, narratives, and instructions related to sequences, cycles, or activities.

    Effective descriptions of either category have many common characteristics.

  • Effective Descriptions State a clear, limiting title. Provide and identify an objective view, a clearly identified physical

    point of view. Develop a clear organizational pattern:

    1. The description is logically divided into discrete parts. 2. The parts are presented in a spatial, functional, or chronological

    sequence.3. The pattern is identified at the beginning.4. Sub-topics are identified by headings

  • Describe the function of each part or phase. Provide descriptive detail appropriate for the reader. Use frequent, well-placed visuals. Feature precise, accurate diction and concise phrasing. Employ straightforward sentences and paragraphs.

    Effective Descriptions

  • Three Types of Process Description

    1. Process Analysis (How something works or happens)

    2. Process Narrative (How something was done)

    3. Process Instructions (How to do or make something)

    5

    PresenterPresentation NotesMay or may not have a human element

  • Process Analysis An explanation of the process, analyzing it based on

    principles of action. Every step is analyzed, based on the principles

    involved (e.g. why and how a step occurs) Third person, indicative mood, active voice. Passive voice may be used to emphasize the process

    itself.

    6

    PresenterPresentation NotesMay or may not have a human element

  • Process Narrative Describes how a process was accomplished.

    First or third person, indicative mood, past tense, active voice (operator), passive voice (system or mechanism).

    7

    PresenterPresentation NotesActive voice emphasizes the operators actions, while the passive voice emphasizes actions of a system or mechanism.

  • Process Instructions

    Steps for accomplishing a process.

    Second person, present tense, active voice.

    8

  • What is a Process Analysis?A process analysis explains sequential events to readers who:

    Need enough details to understand an action or process

    o How something is done

    o How something works

    o How something happens

    but not necessarily instructions on how to complete it.

    9

  • Guidelines for Writing Process Descriptions

    Consider your purpose:

    Who is reading the process description and why?

    What are the circumstances under which they need such an explanation?

    10

  • Guidelines for Writing Process DescriptionsChoose a principle for segmenting suited to

    your readers and your purpose

    For understanding Organize around concerns of interest or use to readers.

    For deciding Make the options clear.

    For performance Support an efficient comfortable rhythm of work.

    11

  • Guidelines for Writing Process DescriptionsUse a principle of segmenting to group the process

    steps

    Chronological by sequence of steps

    Purposive by purpose of the steps (e.g., preparation, performance, analyzing results)

    Tools used by tools used (e.g. keyboard function keys, numeric keypad, mouse).

    12

  • Guidelines for Writing Process Descriptions

    Use graphics appropriately

    Graphics supporting text?

    or:

    Text supporting graphics?

    For international publication, emphasize graphics.

    13

    PresenterPresentation NotesComposting animation

  • Use format elements appropriately

    Bulleted lists for items without a specific order or number.

    Numbered lists for:o Order by priority or importanceo Listing a specific number of or for items

    14

  • Guidelines for Writing Process Descriptions

    Use appropriate diction

    Voice:

    Active voice when what the operator does is important.

    Passive voice when an operator does not exist or is unimportant.

    15

  • Guidelines for Writing Process Descriptions Be precise, so that information is verifiable

    Use specific and accurate terms.

    Consider the value (and pitfalls) of metaphor.

    On the fruit sorting line, the processor is the brain of the machine, the infrared sensors are the eyes, and the automatic sorters are the hands.

    16

  • Guidelines for Writing Process Descriptions

    Organize in a chronological sequence

    Processes are chronological:

    by order of performance, or

    by order of occurrence.

    e.g. Flows from A to B to C

    17

    PresenterPresentation NotesOrder of performance: what has to be done firstOrder of Occurrence: what happens first

    For example: The grey water from the elevated holding tank flows through the overhead piping to the UV settling tank

  • Guidelines for Writing Process Descriptions

    Format consistently and informatively:

    Headings and sub-headings should show hierarchy

    Use informative headings to distinguish major phases

    Use a consistent format throughout

    18

    PresenterPresentation NotesIntro/Body/Conclusion: see slides 19 and 20

  • Format for Process Descriptions

    Title

    short, clear and informative

    Introduction

    Identify product or mechanism can use an operational definition.

    Describe relevance, context, and/or importance of this process.

    19

  • Format for Process Descriptions

    Introduction

    Summarize principles of operation:

    Describe the principle.

    Describe how the mechanism works due to that principle.

    20

  • Format for Process Descriptions

    Introduction

    Summarize major sequences of operation:

    Sequence: two or more related events occurring in predetermined order.

    Clarifying and descriptive details.

    21

  • Format for Process Descriptions

    Introduction (optionally): Identify intended audience

    Give additional explanatory background information.

    Identify relevant parts and materials.

    Provide visual overview.

    22

  • Format for Process DescriptionsBody

    Step-by-step explanation of the process, in chronological order.

    For each phase: Provide a subheading Define the phase Identify its goal Optionally, list parts/materials and give an

    illustration.

    23

  • Format for Process Descriptions

    Body

    For each phase:

    Present chronological details and analysis.

    Explain theory of operation, if not already done.

    Explain how this phase relates to the next phase.

    24

  • Format for Process Descriptions

    Conclusion

    Summarize major phases of long/complex process.

    Discuss theory of operation if not already done.

    Discuss how phases interrelate to bring about desired result.

    Explain applications if not obvious.

    25

  • Format for Process Descriptions

    Use illustrations as much as possible to:

    Facilitate understanding

    Reduce text.

    26

  • How a Toilet FlushesWe all know what happens when we flush, but do we know how it happens? The following steps take us through the flush cycle.1. Pushing on the handle pulls the chain, which releases the

    flush valve. 2. About 2 gallons (7.6 L) of water rush from the tank into

    the bowl in about three seconds. The flush valve then reseats.

    3. This rush of water activates the siphon in the bowl. The siphon sucks everything in the bowl down the drain.

    4. Meanwhile, when the level of the water in the tank falls, so does the float. The falling float turns on the refill valve.

    5. Water flowing through the refill valve fills the tank as well as the bowl. As the tank water rises, the float rises, and when it reaches a certain level the refill valve shuts off.

    NOTE: Should something go wrong and cause the refill valve to keep running, the overflow tube prevents a flood.

    6. Once the tank and bowl are refilled, the cycle can repeat.

    a) Informative title

    b) Logically ordered steps/stages/phases

    c) Appropriate level of technicality

    d) Visual aids

    e) Forecasting

    f) Chronological markers

    g) Appropriate terminology

    27

    PresenterPresentation NotesElements of Process Descriptions

    Informative titleLogically ordered steps/stages/phasesAppropriate level of technicalityVisual aids Appropriate terms, phrasing and paragraph structure: Forecasting statement in the introduction Next, then, finally to mark chronology Appropriate technical terminology.

  • Exam details Mid-term a timed event beginning next

    Wednesday at 6pm and available until midnight The mid-term will appear on D2L and will be a

    timed, 2-hour exam Know definitions; components and types Know key elements of and distinctions between

    technical (static) and process descriptions (phased/chronological and analysis vs narrative)

    28

    Comm. 1009: Week 5Description commonalitiesEffective DescriptionsSlide Number 4Three Types of Process DescriptionProcess AnalysisProcess NarrativeProcess InstructionsWhat is a Process Analysis?Guidelines for Writing Process DescriptionsGuidelines for Writing Process DescriptionsGuidelines for Writing Process DescriptionsGuidelines for Writing Process DescriptionsUse format elements appropriatelyGuidelines for Writing Process DescriptionsGuidelines for Writing Process DescriptionsGuidelines for Writing Process DescriptionsGuidelines for Writing Process DescriptionsFormat for Process DescriptionsFormat for Process DescriptionsFormat for Process DescriptionsFormat for Process DescriptionsFormat for Process DescriptionsFormat for Process Descriptions Format for Process DescriptionsFormat for Process Descriptions Slide Number 27Exam details