CE185 Writing for Computer Engineers

Catalog copy

CE185. Writing for Computer Engineers. F, W.  Writing by engineers and
computer scientists, not to general audiences, but to engineers,
engineering managers, and technical writers. Exercises include job
application and resume, in-code documentation, algorithm description,
naive-user documentation, library puzzle, survey article, proposal,
progress report, formal technical report, and oral
presentation. Ability to read Pascal or C is assumed. Courses such as
Computer Science 12A or 60G or 60N are sufficient and recommended for
students lacking Pascal or C reading ability. 

Prerequisites: satisfaction of C (composition) general education
requirement and Subject A requirement; Computer Science
12B. Enrollment restricted to computer engineering, computer science,
electrical engineering, and information systems management
majors. (General Education Code: W.)

                      
Explanation of prerequisites

Students should already be able to write simple documents (composition
requirment) and to read code written in a high-level language (CS12B).

Required Skills to pass the course

1. Should be able to produce technical documentation for engineers,
   engineering managers, and other specialized audiences
2. Specific skills include
      a. ability to produce a document with correct grammar and punctuation
         with well-formed sentences in appropriate paragraph form.
      b. ability to produce a well-organized and readable document
      c. ability to use visuals, including graphs, tables, figures
      d. ability to produce a document for a specific audience or audiences

Core topics (must be taught)
1. Audience assessment
2. Writing letters
3. Writing memos
4. Writing for multiple audiences
5. Documenting programs
6. Proper citation/plagiarism
7. Using the library
8. Writing formal reports
9. Ethics
10. Oral presentations
11. Peer editing
  
  
Optional topics
1. Presenting a poster
2. Progress reports
  
Text
  
Huckin and Olsen, "Technical Writing and Professional Communication for
Nonnative Speakers of English", McGraw Hill, 1983
  
Strunk and White, "The Elements of Style", Bartleby, 1918
  
Kevin Karplus and Dan Scripture, "Workbook for CMPE 185 Technical
Writing for Computer Engineers and Computer Scientists" 
  
Prepared by Tara Madhyastha, 04/02