Syllabus

Course Information

Technical Writing
ENG2575, D494, Spring 2022
Thursdays, 6:00pm-8:30pm
N601B

Contact and Office Hours

Professor Ellis
Office Hours: Wednesday 5:00-6:00pm in Namm N520 or by appointment.
Email: jellis@citytech.cuny.edu
Blog: https://dynamicsubspace.net

Course Description

Technical Writing is about managing complexity. It is about providing the right information, in the right way, for the right audience, at the right time. It is about communicating technical ideas using sound rhetorical choices and synergistic modalities (e.g., WOVEN, or written, oral, visual, electronic, and nonverbal) while maintaining the highest level of professionalism and ethics. In this class, you will have invaluable opportunities to learn the theory, skills, and heuristics of technical writing through projects relevant to your degree program, and you will develop a set of documents that you can include in your professional portfolio. This course is designated Writing Intensive.

Learning Objectives and Prerequisites

ENG2575 Course Learning Outcomes

Expectations of Students

• As a rule of thumb, students should spend twice as much time per week as the credit hours of a class on assigned readings, homework, and projects. Since this is a three hour class, students should expect to spend six hours per week on these things. Due to some projects being smaller and others larger, these six hours per week can be thought of as on average–sometimes you might need to spend less than six hours per week and other times you might need to spend more.
• Due to the college’s approved course learning outcomes (see link above), there are required collaborative projects in this class. Students are expected to make every effort to work with their team throughout the semester–beginning with peer-review and progressing to the large collaborative project. The baseline means of communication for each team will be via your campus email account. However, I encourage students to discuss and devise other means of communication that facilitate the work in the class, such as Microsoft Teams, Zoom, Slack, Discord, etc. (with the understanding that all team members can use them for free and that all team members have the required resources to use a given communication technology–otherwise, a different choice must be made to accommodate the needs and capabilities of all team members).
• Each student should be meeting deadlines on assignments and following through on all team-based responsibilities volunteered or delegated. But, in the event that you can’t follow through on something, you should email Prof. Ellis and your teammates about the situation. While all situations don’t have to be explained (e.g., a personal emergency), each communication about not fulfilling a responsibility should include concrete and specific asks–may I have this much extra time, may I deliver this file to you by this date and time, etc. Politeness (e.g., please and thank you) and professionalism (being collegial, respectful, clear, etc.) can go a long way!
• No one should suffer in silence in our class. Put another way: communication is key to your success in the class. Students should email Prof. Ellis or visit weekly office hours to discuss the class, assignments, and teamwork. Especially considering the collaborative work, it is imperative that each team keep Prof. Ellis in the loop about any challenges or problems within a team so that he can arrange an intervention. Additionally, maintain communication with your teammates about your availability, completing tasks, asking questions, etc.

Required Texts

• David McMurrey, Online Technical Writing, https://www.prismnet.com/~hcexres/textbook/
• Purdue OWL, Professional and Technical Writing, https://owl.purdue.edu/owl/subject_specific_writing/professional_technical_writing/index.html
• Purdue OWL, IEEE Style, https://owl.purdue.edu/owl/research_and_citation/ieee_style/ieee_overview.html
• IEEE Reference Guide, https://ieeeauthorcenter.ieee.org/wp-content/uploads/IEEE-Reference-Guide.pdf
• Victoria University, Getting Started with IEEE Referencing, https://libraryguides.vu.edu.au/ieeereferencing/gettingstarted
• Other brief readings will be assigned as part of in-class assignments and exercises.

Required Resources

• Computer access, word processing software, and a means of saving your work securely.
• Access to a printer.
• Access to your City Tech email.
• Access and accounts at https://openlab.citytech.cuny.edu and other designated web sites.
• Cloud-based storage for saving a backup of all your work.
• Google Drive/Gmail account for collaborative writing.
• Other communication software or services that are freely available and decided on by each team (e.g., Microsoft Teams, Discord, Slack, text messaging, phone calls, etc.).

Grade Distribution

Individual: Weekly Memoranda, 15%

Each week, students will write and print a one-page memo following parameters given in the previous week’s lecture. Many of these memos require student to use an approved City Tech Library’s Databases and other resources to find an article relating to their field of study and read it. Then, they will write a one page memo that fulfills the parameters of a given week’s assignment. These memos help students learn more subjects in their field of study while making observations and engaging the way the articles they discover demonstrate technical writing.

Individual: 500-Word Article Summary, 10%

Individually, you will write a 500-word summary of a technical or scientific article that demonstrates: 1. ability to identify key processes and concepts in a professional science or technology article. 2. ability to describe complex processes and concepts clearly and concisely. 3. an awareness of audience. The summary should cite the article and any quotes following IEEE format. The article selected should be used in the next project: Expanded Definition.

Individual: 750-1000-Word Expanded Definition, 15%

Individually, you will write a 750-1000 word expanded definition of a technical or scientific term, with cover memo, which demonstrates: 1) correct memorandum format, 2) knowledge of the etymology and historical development of the term, 3) examples of the term’s use in various written contexts, 4) ability to compare and contrast various uses of the term, 5) use and citation of sources with proper attribution, and 6) awareness of audience. At least four library-sourced citations (one from the previous project: Article Summary) are required and should be cited following IEEE format. The term selected by the student for this project should be used and of significant importance to the next project: Instructional Manual.

Individual: 1500-2000-Word Instructional or Training Manual, 20%

Individually, you will write a 1500-2000-word instructional or training manual that demonstrates: 1) ability to explain a task/process in clear, concise language, 2) selection and definition of appropriate terminology and concepts, 3) awareness of the intended user/audience, and 4) knowledge of instructional manual format. All diagrams, illustrations, or photos must be created by the student and integrated into his or her manual. At least six library-sourced citations (two from the previous project: Expanded Definition) are required and should be documented according to IEEE format.

Collaborative: 4000-6000-Word Analytical Research Report, 20%

The Analytical Research Report, Oral Report, and Website projects are interconnected and completed with a team of several students. The Analytical Research Report anchors all of the collaborative projects. Each team member contributes 1000-1500-word contribution to a 4000-6000-word analytical research report on a scientific or technological problem that demonstrates: 1) knowledge of the history and context of the problem, 2) knowledge of the causes and nature of the problem, 3) ideas for solving the problem, 4) the ability to explain the problem and offer possible solutions to a general audience, 5) the ability to integrate written work with the written work of a partner or partners in a coherent report, and 6) knowledge of proper research report format. At least ten library-sourced citations must be included. Any outside sources cited should be documented according to IEEE format.

Collaborative: Seven-to-Ten-Minute Oral Analytical Research Report on a Scientific or Technological Problem, 10%

The goal of this part of the collaborative projects is to transform your written report into a summarized, spoken presentation anchored by a PowerPoint or other visual presentation supplement. As a team, adapt and present your analytical research report as an oral presentation that demonstrates: 1) knowledge of oral presentation techniques and conventions, 2) the ability to organize a presentation effectively, 3) the ability to incorporate various media into the presentation, including appropriate computer software, 4) awareness of audience, 5) the ability to communicate the value of the product or service in clear spoken English, 6) the ability to answer audience questions, 7) the ability to collaborate productively with a partner or partners, and 8) the ability to explain the problem and offer possible solutions to a general audience.

Collaborative: Website Advertising a Product or Service Responding to the Analytical Research Report and Oral Presentation, 10%

The goal of this part of the collaborative projects is to imagine a service or product that your team can offer that is related to your research report and oral presentation, both of which will be featured on the website in some way. The website should demonstrate: 1) knowledge of the product or service offered, of pertinent market forces, and of the potential customer base, 2) basic knowledge of web page design and composition, including appropriate software. The website will be based on your presentation and it is encouraged to be integrated into your presentation (perhaps to demonstrate how your team is promoting your product or service). All graphics, logos, design, and text must be created by your team.

Attendance and Lateness Policy

The expectation for successful and respectful college students is to arrive on time and attend all classes. Following City Tech’s policy, attendance is recorded and reported for each class meeting. Attendance and class participation are essential and excessive absences may affect the final grade. Students who simply stop attending will receive a grade of “WU” (unofficial withdrawal – attended at least once).

Policy for Late Work

Due dates for weekly assignments and major projects are provided on the schedule below. Assignments submitted late will incur a 10-point grade reduction for each day they are late. No assignments are accepted after the last day of class. Students are encouraged to talk with Prof. Ellis should anything interfere with their ability to complete work in a timely manner.

Required Format for Papers

All formal writing and citations should follow IEEE guidelines. See the Purdue OWL IEEE section for more information: https://owl.purdue.edu/owl/research_and_citation/ieee_style/ieee_overview.html. Remember in your research paper that quoting is far more persuasive than paraphrasing, and in either case, your use of others ideas or writing must be properly cited to give credit where credit is due and to maintain your own academic integrity.

Accessibility Statement

City Tech is committed to supporting the educational goals of enrolled students with disabilities in the areas of enrollment, academic advisement, tutoring, assistive technologies and testing accommodations. If you have or think you may have a disability, you may be eligible for reasonable accommodations or academic adjustments as provided under applicable federal, state and city laws. You may also request services for temporary conditions or medical issues under certain circumstances. If you have questions about your eligibility or would like to seek
accommodation services or academic adjustments, you can leave a voicemail at 718 260 5143, send an email to Accessibility@citytech.cuny.edu or visit the Center’s website at http://www.citytech.cuny.edu/accessibility/ for more information.

College Policy on Academic Integrity

Students who work with information, ideas, and texts owe their audience and sources accuracy and honesty in using, crediting, and citing sources. As a community of intellectual and professional workers, the College recognizes its responsibility for providing instruction in information literacy and academic integrity, offering models of good practice, and responding vigilantly and appropriately to infractions of academic integrity. Accordingly, academic dishonesty is prohibited in CUNY and at New York City College of Technology, and is punishable by penalties, including failing grades, suspension, and expulsion. The complete text of the College policy on Academic Integrity may be found in the Academic Catalog here.

Diversity and Inclusive Education Statement

This course welcomes students from all backgrounds, experiences and perspectives. In accordance with the City Tech and CUNY missions, this course intends to provide an atmosphere of inclusion, respect, and the mutual appreciation of differences so that together we can create an environment in which all students can flourish. It is the instructor’s goal to provide materials and activities that are welcoming and accommodating of diversity in all of its forms, including race, gender identity and presentation, ethnicity, national origin, religion, cultural identity, socioeconomic background, sexuality and sexual orientation, ability, neurodivergence, age, and etc. Your instructor is committed to equity and actively seeks ways to challenge institutional racism, sexism, ableism and other forms of prejudice. Your input is encouraged and appreciated. If a dynamic that you observe or experience in the course concerns you, you may respectfully inform your instructor without fear of how your concerns will affect your grade.  Let your instructor know how to improve the effectiveness of the course for you personally, or for other students or student groups. We acknowledge that NYCCT is located on the traditional homelands of the Canarsie and Lenape peoples.

Tentative Schedule

Week 1, Thursday, Feb. 3

Activities this week: Introduce Technical Writing and discuss successful class study habits.

Read by next week: “What is Technical Communication?”, http://wps.prenhall.com/wps/media/objects/5547/5681092/pdfs/CH01.pdf, Laura Portwood-Stacer, “How to Email Your Professor (Without Being Annoying AF),” https://medium.com/@lportwoodstacer/how-to-email-your-professor-without-being-annoying-af-cf64ae0e4087#.1m6lc0rkd, and “How to Summarize a Research Article,” https://writingcenter.uconn.edu/wp-content/uploads/sites/593/2014/06/How_to_Summarize_a_Research_Article1.pdf.

Due by next week: First Weekly Memo.

Week 2, Thursday, Feb. 10

Activities this week: Introduce 500-Word Summary.

Read by next week: “Definition,” https://www.westerntc.edu/sites/default/files/student-life/documents/OWC/Definition.pdf

Due today: Weekly Memo.

Week 3, Thursday, Feb. 17

Activities this week: Peer review Article Summary and introduce on Expanded Definition.

Due today: Weekly Memo.

Week 4, Thursday, Feb. 24

Activities this week: Work on Expanded Definition.

Read by next week: “Instructions” and “Standard operational policies and procedures” linked from David McMurrey’s Online Technical Writing: https://www.prismnet.com/~hcexres/textbook/

Due today: Weekly Memo and Article Summary Project.

Week 5, Thursday, Mar. 3

Activities this week: Peer review Expanded Definition and introduce Instruction Manual.

Due today: Weekly Memo.

Week 6, Thursday, Mar. 10

Activities this week: Work on Instructional Manual.

Due today: Weekly Memo and Expanded Definition.

Week 7, Thursday, Mar. 17

Activities this week: Continue 1500-2000-Word Instructional Manual.

Due today: Weekly Memo.

Week 8, Thursday, Mar. 24

Activities this week: Continue 1500-2000-Word Instructional Manual.

Read by next week: “The Basics of Working on Teams,” https://hr.mit.edu/learning-topics/teams/articles/basics, and Steven D. Krause’s “How to Collaborate and Write with Others,” http://www.stevendkrause.com/tprw/Chapter%204.pdf

Due today: Weekly Memo.

Week 9, Thursday, Mar. 31

Activities this week: Peer review draft of your Instructional Manual and introduce Collaboration Projects (Research Report, Website, and Oral Presentations).

Due today: Weekly Memo.

Week 10, Thursday, Apr. 7

Activities this week: Meetings with teams to discuss Collaboration Project plan.

Due today: Weekly Memo and Instructional Manual.

Week 11, Thursday, Apr. 14

Activities this week: Continue Collaboration Project.

Due today: Weekly Memo.

Spring Recess, Apr. 15-Apr. 22

Week 12, Thursday, Apr. 28

Activities this week: Continue Collaboration Project.

Due today: Weekly Memo.

Week 13, Thursday, May 5

Activities this week: Continue Collaboration Project.

Due today: Weekly Memo.

Week 14, Thursday, May 12

Activities this week: Peer review Collaboration Research Report.

Due today: Weekly Memo.

Week 15, Thursday, May 19

Activities this week: Collaborative Research Presentations.

Due today: Weekly Memo, Research Report (one copy from your team), Research Presentation (delivered in-person), and Research Website (link included in Research Report).