Course Design Guide ENG/221 Version 5 1 Course Design Guide College of Information Systems & Technology ENG/221 Version 5 Technical Writing Fundamentals Copyright © 2012, 2011, 2010, 2009, 2008 by University of Phoenix. All rights reserved. Course Description This course covers the fundamentals and best practices of using written communication in business and in the information technologies. Topics include strategies, techniques, and nuances for producing e-mails, memos, reports, proposals, project specifications, and user manuals, as well as other technical documents. Policies Faculty and students/learners will be held responsible for understanding and adhering to all policies contained within the following two documents: University policies: You must be logged into the student website to view this document. Instructor policies: This document is posted in the Course Materials forum. University policies are subject to change. Be sure to read the policies at the beginning of each class. Policies may be slightly different depending on the modality in which you attend class. If you have recently changed modalities, read the policies governing your current class modality. Course Materials Dobrin, S. I., Keller, C. J., & Weisser, C. R. (2010). Technical communication in the twenty-first century (2nd ed.). Upper Saddle River, NJ: Prentice Hall. Gerson, S. J., & Gerson, S. M. (2012). Technical communication: Process and product (7th ed.). Upper Saddle River, NJ: Prentice Hall. All electronic materials are available on the student website. Week One: The Technical Writing Process Oct 29 – Nov 4 Details Objectives 1.1 Identify how writing methods are used in the corporate environment. Compare differences between technical and expository writing. Reading Read the Week One Read Me First. Reading Read Ch. 1, “An Introduction to Technical Communication,” of Technical Communication Process and Product. Reading Read Ch. 2, “The Communication Process: Prewriting, Writing, and Rewriting,” of Technical Communication Process and Product. Reading Read Ch. 3, “Clarity, Conciseness, Accuracy, and Ethics in Technical Communication,” of Technical Communication Process and Product. Due Points Course Design Guide ENG/221 Version 5 Participation Participate in class discussion. Participation is counted for posts made in the main folder only. Each student must respond to four students each week after they have posted their response to the discussion questions/activity. Each response must be a minimum of 150 words. Learning Team Instructions User Manual and Presentation (Preparation) Begin preparation for completing the User Manual and Presentation due in Week Five. Select one of the following tools as the focus of your user manual and presentation: Student website University Library Virtual Organizations Online discussion forums Write a 15- to 20-page user manual for your selected tool. Provide effective, clear, concise, accurate, and coherent written communication that introduces first-time students to your tool. Include the following items in your manual: Table of contents Headers and footers that include page numbers, copyright information, and other necessary information Headings Appropriate font Written instructions for accessing, navigating, and using the selected tool Visual elements, such as images, flowcharts, tables, and screenshots Effective page layout, including the order of information, use of whitespace, and highlighting Terminology definitions, a key to define any symbols or diagrams used, and any other necessary information to help the user navigate the manual Create a 7- to 10-slide annotated or narrated Microsoft® PowerPoint® presentation that could be presented in a student orientation meeting to introduce your team’s tool. Include the following in your presentation: Speaker notes Introduction slide Conclusion slide Headings See instructor policies 2 2 Course Design Guide ENG/221 Version 5 3 Graphics Easy-to-read fonts Appropriate contrast Effective slide design and layout, including the amount of information and use of white space Note. For tips on how to add narration to your presentation, refer to the University of Phoenix Material: Recording a Narration located on the student website. Individual Workplace Communication Comparison Complete the University of Phoenix Material: Workplace Communication Comparison located on the student website. Discussion Question Supporting Activity Establish Your Purpose and the Delivery Medium Resources: SkillSoft (2012). Writing for Technical Professionals: Preparation and Planning. 11/4 10 11/2 2 Note. This Week One assignment is recommended as an in-class activity for local campuses. Complete Establish Your Purpose and the Delivery Medium module in Skillport. Write a 200- to 300-word response to the following questions: What are the four main purposes of technical writing? What is the goal of informative writing? What is the aim of instructional writing? What is the purpose of reference writing? What is the aim of persuasive writing? When should a document be delivered online? Your response must be made by day 4 each week to allow enough time for all students to review your post and respond with their participation posts. Discussion Question Two Respond to the second discussion question posted in the main folder 11/3 2 Learning Team Charter Create and post a learning team charter. Remember that the team charter is used as the ground rules for the team and as a conflict resolution tool if necessary. The statements made must be collaborative – no “I” statements. 11/4 2 Due Points Week Two: Technical Writing in the Corporate Environment Nov 5 - 11 Details Objectives 2.1 Identify intellectual property issues in the corporate environment. Design a memo with appropriate formatting for the corporate environment. Reading Read the Week Two Read Me First. Course Design Guide ENG/221 Version 5 4 Reading Read Ch. 4, “Communicating Effectively to Your Audience in a Multicultural World,” of Technical Communication Process and Product. Reading Read Ch. 6, “Routine Correspondence—Memos, Letters, E-mail Messages, Instant Messages, and Text Messages,” of Technical Communication Process and Product. Reading Read Ch. 4, “Ethics and the Workplace Writer,” of Technical Communication in the TwentyFirst Century. Reading Read Ch. 6, “Researching and Evaluating Source Material,” of Technical Communication in the Twenty-First Century. Participation Participate in class discussion. See instructor policies 2 Individual Corporate Memos Select and complete one of the following assignments. 11/11 10 Option 1: Web Conferencing Programs Research Memo Read the following scenario: Your manager wants to use web conferencing to hold weekly status meetings, but has not decided on a program. You have been assigned to do some basic research on available web conferencing programs. Research and compare different web conferencing programs using the Internet. Write a memo to your manager that describes the web conferencing program you believe is the best choice. Explain why you selected this program. Include a list of all web conferencing programs you reviewed. Consider using a table to present your references. Format the memo properly for management review. Use the course texts as a resource. Include a minimum of two citations from your research. Option 2: Memo Evaluation Use a memo you have written, one that one of your peers or your manager has written, or one of the following from the University of Phoenix Virtual Organizations’ intranet sites: Riordan Manufacturing: China Relocation Memo located under Finance & Accounting > Communications Riordan Manufacturing: HR Integration Project Manager Memo located under Human Resources > Communications Course Design Guide ENG/221 Version 5 5 Kudler Fine Foods: Training for New Cash Registers Memo located under Administration > Communications McBride Financial Services: Programming Languages E-mail located under Administration > Communications Evaluate the memo using the following criteria: Organization Clarity Tone Writing style How you reacted to the memo Write a 300- to 500-word report in which you comment on each of the criteria and make suggestions for improvement. Discussion Question Supporting Activity Intellectual Property Overview Resources: SkillSoft (2012). Intellectual Property Overview. 11/8 2 11/10 2 Due Points Complete Intellectual Property Overview module in Skillport. Write a 200- to 300-word response to the following questions: What is intellectual property? What do intellectual property laws define? What are the categories of intellectual property protections? What international treaties are in place for protection of U.S. intellectual property? Discussion Question Two Respond to the second discussion question posted in the main folder Week Three: Writing Reports and Proposals Nov 12 – 18 Details Objectives 3.1 Implement effective document design in technical writing. Develop a request for proposal. Course Design Guide ENG/221 Version 5 6 Reading Read the Week Three Read Me First. Reading Read Ch. 9, “Document Design,” of Technical Communication Process and Product. Reading Read Ch. 10, “Using Visual Aids in Technical Communication,” of Technical Communication Process and Product. Reading Read Ch. 16, “Short, Informal Reports,” of Technical Communication Process and Product. Reading Read Ch. 17, “Long, Formal Reports,” of Technical Communication Process and Product. Reading Read Ch. 18, “Proposals,” of Technical Communication Process and Product. Reading Read Ch. 20, “Proposals and Requests for Proposals,” of Technical Communication in the Twenty-First Century. Participation Participate in class discussion. Individual Request for Proposal Read the following scenario: See instructor policies 20 11/18 You are a manager or supervisor of a company, and you need to acquire trainers to train your staff on using Microsoft ® Office® programs. You must request proposals from various training companies and trainers to fill this need. Write a 3- to 5-page request for proposal (RFP) and include the following: Introduction to the company o o Introduction to the project o o o o Description of your company Your company’s business goals Project goals Time allocated to complete the project Budget for the project Description of the needed training Administrative information o o o Desired qualifications Requirements for formatting and submitting proposals Confidentiality notice of all proposal submissions 2 Course Design Guide ENG/221 Version 5 o o o o o 7 Employer and organizational reference requirements Contact information for clarification or questions Deadline for proposal submission Timeframe for vendor selection Selection criteria Other items that may be important for inquiring candidates Format the RFP using examples from your textbooks or additional research and consistent with APA guidelines. The following must be included: Discussion Question Supporting Activity The Essentials of Technical Writing Cover page Page numbers Headers and footers Headings Resources: SkillSoft (2012). Writing for Technical Professionals: Effective Writing Techniques. 11/15 2 11/17 2 Due Points Complete The Essentials of Technical Writing module in Skillport. Write a 200- to 300-word response to the following questions: What is page design and why is it important? What types of mistakes are common in technical writing? Discussion Question Two Respond to the second discussion question posted in the main folder Week Four: Writing Technical Instructions and User Manuals 11/19 – 11/25 Details Objectives 4.1 Determine criteria for writing a user manual. 4.2 Develop a user manual with appropriate visual elements. Design effective written communication for user manuals and technical instructions. Reading Read the Week Four Read Me First. Reading Read Ch. 12, “Technical Descriptions and Process Analyses,” of Technical Communication Process and Product. Reading Read Ch. 13, “Instructions, User Manuals, and Standard Operating Procedures,” of Technical Communication Process and Product. Reading Read Ch. 18, “Technical Instructions,” of Technical Communication in the Twenty-First Century. Course Design Guide ENG/221 Version 5 Reading Read Ch. 19, “Manuals,” of Technical Communication in the Twenty-First Century. Participation Participate in class discussion. Individual User Manual Critique Write a 2- to 3-page critique of an online user manual. You may download manuals from a website of your choice. Include the manual link in your submission. See instructor policies 8 2 10 11/25 Identify and describe the criteria you used to critique the selected manual. Provide at least five criteria. Provide positive and negative examples from the online manual that represent each aspect of your designated criteria. Format your critique consistent with APA guidelines. Discussion Question Supporting Activity Short Answer Question: User Manual Criteria Write a 200- to 300-word response to the following question: Discussion Question Two Respond to the second discussion question posted in the main folder 11/22 2 11/24 2 Due Points Why is it important to establish the necessary criteria before writing a user manual? What criteria are frequently missing or vague in user manuals and instruction? Provide examples of missing or vague criteria you have recently seen. Week Five: Preparing Presentations 11/26 – 12/2 Details Objectives 5.1 Implement effective layout and design in presentations. Develop a professional slideshow presentation. Reading Read the Week Five Read Me First. Reading Read Ch. 19, “Oral Communication,” of Technical Communication Process and Product. Reading Read Ch. 5, “Technical Communication in a Transnational World,” of Technical Communication in the Twenty-First Century. Reading Read Ch. 23, “Presentations,” of Technical Communication in the Twenty-First Century. Participation Participate in class discussion. See instructor policies 2 Course Design Guide ENG/221 Version 5 Learning Team User Manual Finalize and submit the user manual. See week one for full description. 12/2 20 Discussion Question #1 Supporting Activity Basic Presentation Skills: Creating a Presentation Resources: SkillSoft (2012). Basic Presentation Skills: Creating a Presentation. 11/29 2 Complete Basic Presentation Skills: Creating a Presentation module in Skillport. Write a 200- to 300-word response to the following questions: What are the most effective practices in creating and delivering a technical business presentation? Copyright University of Phoenix® is a registered trademark of Apollo Group, Inc. in the United States and/or other countries. Microsoft®, Windows®, and Windows NT® are registered trademarks of Microsoft Corporation in the United States and/or other countries. All other company and product names are trademarks or registered trademarks of their respective companies. Use of these marks is not intended to imply endorsement, sponsorship, or affiliation. Edited in accordance with University of Phoenix® editorial standards and practices. 9