ESSAY : Description assignment

Description Assignment
Contents
Learning Objective​1
Background​1
Special Notes​2
Resources​2
Technical Document 1 Instructions: Non-instructional Process Description​2
Technical Document 2 Instructions: Mechanism Description​4
Planning Document (for Technical Documents 1 and 2)​6
Evaluation Tools​7
Non-instructional Process Description Evaluation Tool​7
Mechanism Description Evaluation Tool (2 pages)​8
Learning Objective
In this assignment students will
• Develop non-instructional process and mechanism descriptions using publication tools
• Apply structure, design, and readability principles to technical documents

YOU WILL CREATE TWO TECHNICAL DOCUMENTS FOR THIS ASSIGNMENT.
Background

Image you’re applying for co-op position at a technical communication company. They want 2 samples of your work on different topics. The first document is a non-instructional process description and the second document is a mechanism description.

They have provided evaluation tools for each (see section Evaluation Tools).

Special Notes

You are NOT expected to buy a publishing tool. Use a free version. If you can’t download documents, provide a link by following the tool’s instructions on how to share document.

50% deduction BEFORE marking for
• inappropriate term
• under word count
• if you do not add your own labels, titles, headings, captions, or call-outs to figures

Technical documents will be marked “0” if
• missing IN-TEXT CITATIONS
• missing REFERENCES
• contain direct quotes
• use examples from class, activities or lessons
• use same topic as previous assignments

Resources

Learning content from Weeks 1-7.
Technical Document 1 Instructions: Non-instructional Process Description
Audience and purpose: This technical document is for college-level students interested in the description. They are not technical communicators.
1. Choose how an organ or part functions OR a sequence of events (see class lecture for topics) and use the following persona to create your non-instructional process description.

2. Select a publishing tool.

3. Write a non-instructional process description (100 – 120 words). Use the evaluation tool and rubric for the technical document criteria. Include an in-text citation and a reference. Paraphrase only. Do not use direct quotes.

What to Hand In
• Either a .pdf or a link to the non-instructional process description designed in a publication tool.
• Completed evaluation tool in a separate file.

Rubric: Non-instructional Process Description 5 marks
Mastered
Proficient
Needs Improvement
5

Process description is non-instructional
Uses sentence definition to introduce process
Steps are clearly defined and uses transitions
Uses APA in-text citations
Transitions used
Term is appropriate
No spelling errors; no grammar errors
Expression is clear, concise, and descriptive
Value statements aren’t used
Descriptive headings appropriate for audience
Reference is included at the end of the document

Structure and Design
Fonts and colours aid readability
Document is scannable
Content is chunked/white space used
4-3
Some steps must be inferred but process is generally understood
Value statements aren’t used
Minor errors
Missing headings or headings not appropriate for audience

2-0
Missing sentence definition
Steps must be inferred
Inappropriate term
Written as instructions instead of a non-instructional process description
Value statements have been used
No transitions
No proofreading
MISSING IN-TEXT CITATION = 0
MISSING REFERENCE = 0
INCLUDES DIRECT QUOTES = 0
For entire document

Technical Document 2 Instructions: Mechanism Description

For the second document, write a mechanism description on something with a specific make and serial number. It is NOT related to your previous document.

Audience and purpose: This technical document is for college-level students interested in the description. They are not technical communicators.

1. Find an object with a specific make and serial number. For example, if you are writing about a clamp, state its product name and serial number. Do not about clamps in general. It can be an object you own.
2. Select a publication tool.
3. Write a 100–150 word technical description logically structuring at least 5 relevant characteristics (see planning sheet for characteristics). If you use a retail site, make sure you cite it.
4. Include one labeled graphic of the same item, and refer to it in your description (e.g., See figure xx). Include a caption with 20 – 50 words.
5. Use the evaluation tool and rubric for the technical document criteria.
6. If you use a retail site, include in-text citations and a reference page at the end of the document.

What to Hand In
• Either a .pdf or a link to the technical description designed in a publication tool.
• Completed evaluation tool in a separate file.

Rubric on next page.

Rubric: Mechanism Description 15 marks
Mastered

Proficient
Needs Improvement

10-8
Introduction and Background
Uses a sentence definition
Includes serial number in the sentence definition
States when or where found or used
Gives general description of object and its function, cause, or effect.
Gives an overview of the contents of the description (transition sentence).
Expression is clear, concise, and descriptive
Value statements aren’t used

Body
Uses at least five characteristics to describe the overall object (see planning sheet) and is specific, descriptors are appropriate for term and discourse community
Order of descriptors is logical
Refers to the graphic
Descriptive headings appropriate for audience.

Structure and Design
Structure aid comprehension
Font and colours use readability principles
Content is chunked

7-6

Missing figure number
Missing headings
Order of characteristics needs improvement
Value statements aren’t used
Headings don’t consider audience/purpose

5-0
Missing sentence definition
Missing characteristics
Inappropriate term
Missing introduction and background
Poor choice of strategies
No proofreading

MISSING SERIAL NUMBER = 0
MISSING IN-TEXT CITATION = 0
MISSING REFERENCE = 0
INCLUDES DIRECT QUOTES = 0
for entire document

5
Graphic
Clear and relevant
Includes title and figure number
Appropriately placed in the document
Labelled with call-outs
Includes captions
No spelling or grammar errors

4-3
Missing some labels but features can be inferred
Minor errors

2-0
Unclear
Missing labels
Missing caption
No proofreading Missing headings

Planning Document (for Technical Documents 1 and 2)
Do not hand in

Use this planning sheet for both of the projects described in the assignment. Remember, the non-instructional process description and the technical description are on different topics.
A. Technical Document 1: Non-instructional Process Description.

Choose a biological, ecological, mechanical, social, or psychological sequence of events that results in a specific outcome. Briefly list the process stages. Get feedback then begin drafting your process description.

B. Technical Document 2: Mechanism Description

1. Write a sentence definition for the object you’ll be describing. Where is it found or what is it used for?
2. What is its general use, cause, or effect.
3. Circle and rank all the characteristics that apply to the object.
color height width
shape weight materials
texture width location
methods of attachment depth amount
pattern, design ingredients age
subparts length finish
temperature moisture content smell

Select the top 5. You’ll use these in your assignment. Begin adding specific detail to draft your technical description.

Evaluation Tools
Hand in
Non-instructional Process Description Evaluation Tool

Non-instructional Process Description Evaluation Tool

Yes
Somewhat
No
Title is appropriate for audience

Process description describes one of the following: biological, ecological, mechanical, social, or psychological sequence of events

Begins with sentence definition which includes class, term, and distinguishing characteristics

Steps are clearly defined

Specific outcome of process is clear

Transitions are logical

Uses APA in-text citations

Expression is clear, concise, and descriptive

Value statements have been removed

Meets the word count requirement

No spelling errors or grammar errors

Fonts aid readability

Template is suitable for audience and purpose

Background colour aid readability

Document is scannable where appropriate

APA reference included at the end of the document

Document is single spaced

Mechanism Description Evaluation Tool (2 pages)
Mechanism Description Evaluation Tool

Yes
Somewhat
No
Technical description is of a specific model or serial number of an object

Sentence definition is one sentence at the beginning of the description

Sentence definition term includes name of object and serial or model number

Distinguishing characteristics are summarized in sentence definition

Introduction
States when or where found or used

Gives general description of object and its function, cause, or effect.

Uses a transition sentence to give an overview of the contents of the description

Body
Uses at least five characteristics to describe the overall object (see planning sheet)

Descriptors are specific

descriptors are appropriate for term and discourse community

Transitions are logical

Order of characteristics is logical

Expression is clear, concise, and descriptive

Value statements have been removed

No spelling errors or grammar errors

Meets the word count requirement

Refers to graphic (See figure XX).

Uses APA in-text citations if appropriate

APA reference included at the end of the document if appropriate

Descriptive headings appropriate for audience

Fonts aid readability

Background colour aid readability

Template is suitable for audience and purpose

Document is scannable where appropriate

Graphic
Figure is the same model and serial number as item in the description

Figure number, title and labels have been added by writer

Figure location is placed to aid comprehension

Figure is appropriate size and clear

Caption is written in sentences

Caption meets the word count

Figure is credited

Expression, structure and design
Title and headings are written for audience

Structure is logical enhancing understandability

Appropriate use of font

Background colour is appropriate

Content is chunked into 7 lines

Document is single spaced

SAMPLE SOLUTION

The mechanism of operation depends on the operating system being used (Dennis, 2018). When there is an update for OS X, there is usually need for a complete removal of the parts that prove to be troublesome which helps the issue completely (Gauci, Michelin & Salles, 2017). However, for windows, a patch management solution can be used where a whole windows patch management process can be automatized so that one doesn’t have to move from one computer to another and manually checking for any missing patches…