Topic : BOAT AIRDOPES 131 PRO

Technical Communication

Professor Jennifer King

Purpose

The user manual is one of the most familiar examples of technical writing. Its purpose is to provide instructions on how to perform a set of tasks in order to perform a job or operate something. Because this can be complex, manuals often include several infrastructures: descriptions, processes, and definitions. Writing a user manual will allow you to implement all aspects of technical communication we have examined this term.

Scenario

You have been hired by me to write a brief user manual for my company's product. In it, you must include a set of instructions for the product, as well as an object description or an expanded definition. You will determine the product, as well as an appropriate organization to "imagine" as my company. This will enable you to conduct the necessary audience and organizational research to determine content and brand.  The result will be a professional document, unified by effective use of brand.

There are two parts of this assignment:

 

1. The User Manual worth 20%

Objective

Before you can begin writing or designing any information product, you need to learn everything you can about your audience, purpose, and use of your document. You also need to relate that information to the appropriate channels (employer, organization contact, writing team, etc.). In this assignment, you will conduct the necessary research and planning and from it, produce a 1-2 page memo outlining your intentions regarding your user manual. 

Instructions

Write an Information Plan/Proposal in memo format and include the following:

1. Memo Opening

                    -Address you audience (me, the organization who owns the "product")

                    -Briefly outline the purpose of the memo and what will follow in the body.

Note: You must define the product and my organization. We can be whatever you would like us to be (a barbeque from Napoleon, a DVD player from Panasonic, a food processor from Cuisinart, scuba gear from Aropect, computer software, etc.).

1. Analysis

Conduct the following research to include in your plan:

1. Description of your project:

-What is your product/policy/procedure?

-What are your goals or objectives?

             b.    Audience and Organization:

                     -Who will use the manual? (Technical level, demographics, characteristics, knowledge level...               

                     -Who is the organization? (Choose a relevant website you imagine to be my company and     

                       analyze it to establish a brand).

1. Purpose

-Why is the manual necessary?

-What is your 'why'?

-What is involved in using the product? (Are there safety warnings, model number (if applicable) or tips that need to be included?  Is there reference material that would be helpful?)

-What tasks must be included in order to use the product properly?

-If they are detailed, should they be broken into sub-tasks?

-How can you convey your purpose to the reader/user?

   3.    Design:

           After your research, provide details around the design plans:

           Rough Outline

                     -Cover - What will appear? (Graphics, title?)

                     -First Page (Table of contents, introduction, warnings?)

           Sections

                    -Description/definition, instructions, graphics (if dependent of infrastructure), order of items

           Final Page

                     -Brief conclusion, company info and reference numbers

           Production guidelines

                     -Colour or black &white, layout, publishing format?

           Schedule

                     -Completion dates (Draft, testing (when, who, how?), revision, publishing)

   4.    Sources:

                      -gather a few sources: 1 primary and 2 secondary

           Primary

                     -Example:  Interview with an expert or professional in an industry, blog, etc.

                      -If you do an interview you are responsible for creating questions and summarizing the content of     

                        that interview.   

                       Include full contact information of your primary source.

           Secondary

                     -Examples:  Manufacturer websites, periodicals or brochures, etc.

                      -Publication dates:  2020 preferred to 2017. See the Georgian College library databases.

           What to do with sources?

                      -Provide a brief summary of two secondary sources that helped you understand the 

                        subject (in addition to the website described above).

                      -For your research, and to make it your own original work, your manual should integrate 

                       information from these sources. Be sure to use in-text citations and an APA 

Resources

       -Your class textbook (Chapters 6&7)

       -Cites & Sources for proper citing

Requirements

       -Memo, 2 pages max, single spaced

       -Submitted as a Word Document

INFORMATION PLAN/PROPOSAL

Technical Communication

Professor Jennifer King

Evaluation Rubric:                                                                                                             Value                       Student Mark

 

Content                                                                                                                                   /15

     Analysis includes

          -Description of project

          -Audience and Organization

          -Purpose

          -Includes summary of one primary source and two 

           secondary sources and their relevance to the manual

          -Tasks

     Design includes:                                                                                                                   /5

          -Outline

          -Production guidelines

          -Schedule

 

Format                                                                                                                                         /5

     Memo:

          -is 1-2 pages typed

          -includes subject line and opening

          -uses headings for organization

 

Sources                                                                                                                                       /5

          -1 primary source listed

          -2 secondary sources listed

          -APA Reference page attached

 

APA Title Page                                                                                                                            /5

          -Page number

          -Assignment, Student Name, Class, Professor, Date

 

Writing Mechanics                                                                                                                    / 5

          -I point off for each error

 

Total                                                                                                                                              /40