Next:
1. Syllabus
Up:
Workbook for CMPE 185
Previous:
Workbook for CMPE 185
Contents
Copyright
Acknowledgements
Contents
1. Syllabus
1. Required Texts
2. Recommended texts--on reserve in the Science Library
3. Also on reserve
4. Other interesting books, not on reserve
5. Homework Assignments
6. Evaluation
7. Collaboration
8. Schedule (due dates)
2. Intake Survey
1. Purpose of the intake survey
2. Pre-requisite verification
3. Language background
3. Job application letter and résumé
1. Goals--audience assessment and letter writing
2. Audience assessment
1. Mass-mailed résumés versus tailored job letters
2. Finding an employment possibility
3. Doing the background research
3. Writing process--letter writing
1. Getting started
2. Doing this assignment
3. Doing the working draft
4. Experimenting with formatting
5. Tailoring your résumé
6. Preparing for peer editing
4. Things to keep in mind for editing
1. Understanding
confidence
in its cultural context
2. Including a statement of an objective or goal
3. Including other categories
5. The final draft
1. Deciding about length
2. Neatness counts
3. Hints
6. What to turn in
4. Hiring Recommendation Memo
1. Goals--reading for content, writing memos
2. Audience assessment--Personnel Director
3. Writing process--persuasive writing
1. How to go about persuading the personnel director
2. Memo format versus letter format
3. Writing in class
5. Electronic mail and newsgroups
1. New forms of communication--new writing styles
2. Flaming
3. Humor
4. Assignment--newsgroup discussion
6. Algorithm Description
1. Goals--multiple audiences, graphics, sophisticated audiences
2. Audience assessment--writing for multiple audiences
3. Writing process--algorithm description
4. Figures and displays
1. Graphics
2. Pseudo-code
5. Explaining recursion
6. Titles, title pages, and executive summaries
7. Things to keep in mind for peer editing
1. About the algorithm
2. Mechanical details
8. The final draft
7. In-program Documentation
1. Goals--recognizing that programs are documents
2. Audience assessment--maintenance programmers
3. Assignment--adding comments to Wirth's code
4. Writing process--in-program documentation
5. Format for in-program documentation
1. Identify your work
2. Use white space freely
3. Indent to show block structure
4. Name variables carefully
5. Use a block comment for each procedure interface
6. Use a block comment inside each procedure to explain method
7. Use a block comment for each data type
8. Use a block comment for each data structure
9. Use a one-line comment for each local variable
10. Use comments sparingly inside the body of the code itself
11. Use assertions.
6. Things to keep in mind for peer editing
7. The final draft
8. Wirth's description of the knight's tour program
8. Naive-user documentation
1. Goals--better paragraphs and writing for non-technical audiences
2. Audience assessment--non-technical audiences
3. Writing process--paragraph structure
4. Things to keep in mind for editing and partner work
5. The final draft
9. Library Puzzle
1. Catalog database (
CAT
and
TEN
)
2. Magazine database (
MAGS
)
3. World-wide web
4. Computer article database (
COMP
)
5. You figure out what indices to use
10. Survey article
1. Goals--short surveys, library practice
2. Choosing your topic
3. Textbook resources
4. Audience Assessment--fellow students
5. Writing process--finding, organizing, writing
1. Library search
2. Organizing the information
3. Writing the paper
6. What to bring for peer editing
7. Final draft
11. Final project proposal memo
1. Goals--proposal writing, choosing the final project
2. Audience assessment--the instructors
3. Writing process--informal proposals
12. Recommendation Letter
1. Goals--writing about people
2. Audience assessment--Award Committee
3. Writing process--persuasive writing
1. How to go about persuading the committee
2. Memo format versus letter format
13. Document specifications
1. Goals--three purposes for document specifications
1. Economy of effort
2. Work planning
3. Writing Organization
2. Audience assessment
3. Writing process--document specifications
1. Outlining is organizing
2. The basic tripartite structure of a formal report
3. Organizing the work and the writing
4. Which projects do not use the
Tripartite Structure
?
4. What to turn in
14. Progress Report
1. Goals--writing progress reports, making sure there is progress
2. Audience assessment--instructors and supervisors
3. Writing process--short progress reports
4. Professional Ethics
1. Honesty is the basis of professional ethics
2. 1979 IEEE Code of Ethics
3. 1990 IEEE Code of Ethics
5. Assignment--final draft only
15. Final project
1. Goals--formal report writing
2. Audience assessment--choose your own
3. Writing process
1. Writing the Report
2. The tripartite structure of a formal report
3. Explanation of
Tripartite Structure
4. A note on page numbering
4. Oral Reports
5. What to turn in
16. Oral Reports
1. Goals--clear oral presentation
2. Meeting the expectations of the audience
3. Presenting your report
1. Using notes, transparencies, charts, and displays
2. Practicing Your Presentation
4. Evaluation of the presentation--form and content
1. Form
2. Content
5. Scheduling the talks
6. Note on oral presentations at SIGGRAPH
Things I Hope Not to See or Hear at SIGGRAPH
Talks read verbatim
Illegible slides
Microtext
Yellow lines on a white background
The entire text of the talk echoed on slides
``I'm sorry these slides are so dark.''
The tops of the speakers' heads
``I'm almost out of time so I'll just run through the rest of the slides real fast.''
``Uh, I guess that's all I have to say.''
Remember
Bibliography
17. Grammar and format notes (read this appendix first)
1. Content errors
2. Discourse structure errors
1. Sections and section headers
2. Paragraphs
3. Pronouns
4. Tone
3. Format errors
4. Sentence structure errors
1. Faults in style
2. Faults in grammar
5. Punctuation errors
1. Hyphens and dashes
2. Quotation marks
3. Parentheses and brackets
4. Commas and related marks
6. Word choice errors
1. Commonly misused words and phrases
2. Sentence grammar affects word choice
Kevin Karplus
Computer Engineering
University of California, Santa Cruz
Santa Cruz, CA 95064
USA
karplus@cse.ucsc.edu
1-831-459-4250
HTML version created 1999-09-23