Next:
1. Syllabus
Up:
CMPE 185 Workbook
Previous:
CMPE 185 Workbook
Contents
Abstract
Copyright
Acknowledgements
1. Syllabus
1.1 Required Texts
1.2 Recommended texts to buy
1.3 Recommended books to browse in the library
1.4 Homework Assignments
1.5 Collaboration
1.6 Schedule (due dates)
1.7 Peer editing
2. Intake Survey
2.1 Purpose of the intake survey
2.2 Pre-requisite verification
2.3 Language background
3. Job application letter and résumé
3.1 Goals--audience assessment and letter writing
3.2 Audience assessment
3.2.1 Mass-mailed résumés versus tailored job letters
3.2.2 Finding an employment possibility
3.2.3 Doing the background research
3.3 Writing process--letter writing
3.3.1 Getting started
3.3.2 Doing this assignment
3.3.3 Doing the working draft
3.3.4 Experimenting with formatting
3.3.5 Tailoring your résumé
3.3.6 Preparing for peer editing
3.4 Things to keep in mind for editing
3.4.1 Understanding
confidence
in its cultural context
3.4.2 Including a statement of an objective or goal
3.4.3 Including other categories
3.5 The final draft
3.5.1 Deciding about length
3.5.2 Neatness counts
3.5.3 Hints
3.6 What to turn in
4. Hiring Recommendation Memo
4.1 Goals--reading for content, writing memos
4.2 Audience assessment--Personnel Director
4.3 Writing process--persuasive writing
4.3.1 How to go about persuading the personnel director
4.3.2 Memo format versus letter format
4.3.3 Writing in class
5. Oral Reports
5.1 Goals--clear oral presentation
5.2 Meeting the expectations of the audience
5.3 Choosing your topic
5.4 Writing process--finding, organizing, composing
5.4.1 Library search
5.4.2 Organizing the information
5.4.3 Preparing your visual aids
5.4.4 Practicing Your Presentation
5.5 Evaluation of the presentation--form and content
5.5.1 Form
5.5.2 Content
5.6 Scheduling the talks
5.7 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
6. Electronic mail and newsgroups
6.1 New forms of communication--new writing styles
6.2 Flaming
6.3 Humor
6.4 Assignment--newsgroup discussion
7. In-program Documentation
7.1 Goals--recognizing that programs are documents
7.2 Audience assessment--maintenance programmers
7.3 Example--knight's tour
7.4 Assignment--adding comments to minimal code
7.5 Writing process--in-program documentation
7.6 Format for in-program documentation
7.6.1 Identify your work
7.6.2 Use white space freely
7.6.3 Indent to show block structure
7.6.4 Name variables carefully
7.6.5 Use a block comment for each procedure interface
7.6.6 Use a block comment inside each procedure to explain method
7.6.7 Use a block comment for each data type
7.6.8 Use a block comment for each data structure
7.6.9 Use a one-line comment for each local variable
7.6.10 Use comments sparingly inside the body of the code itself
7.6.11 Use assertions.
7.7 Things to keep in mind for peer editing
7.8 The final draft
8. Naive-user documentation
8.1 Goals--better paragraphs and writing for non-technical audiences
8.2 Audience assessment--non-technical audiences
8.3 Writing process--paragraph structure
8.4 Things to keep in mind for editing and partner work
8.5 The final draft
9. Library Puzzle
9.1 General library info
9.2 Catalog database
9.3 World-wide web
9.4 INSPEC, PUBMED, and BIOSIS databases
9.5 You figure out what indices to use
10. Final project proposal memo
10.1 Goals--proposal writing, choosing the final project
10.2 Audience assessment--the instructors
10.3 Writing process--informal proposals
11. Algorithm Description
11.1 Goals--multiple audiences, graphics, sophisticated audiences
11.2 Audience assessment--writing for multiple audiences
11.3 Writing process--algorithm description
11.4 Figures and displays
11.4.1 Graphics
11.4.2 Pseudo-code
11.5 Explaining recursion
11.6 Titles, title pages, and executive summaries
11.7 Things to keep in mind for peer editing
11.7.1 About the algorithm
11.7.2 Mechanical details
11.8 The final draft
12. Document specifications
12.1 Goals--three purposes for document specifications
12.1.1 Economy of effort
12.1.2 Work planning
12.1.3 Writing Organization
12.2 Audience assessment
12.3 Writing process--document specifications
12.3.1 Outlining is organizing
12.3.2 The basic tripartite structure of a formal report
12.3.3 Organizing the work and the writing
12.3.4 Which projects do not use the
Tripartite Structure
?
12.4 What to turn in
13. Progress Report
13.1 Goals--writing progress reports, making sure there is progress
13.2 Audience assessment--instructors and supervisors
13.3 Writing process--short progress reports
13.4 Professional Ethics
13.4.1 Honesty is the basis of professional ethics
13.4.2 1979 IEEE Code of Ethics
13.4.3 1990 IEEE Code of Ethics
13.5 Assignment--final draft only
14. Final project
14.1 Goals--formal report writing
14.2 Audience assessment--choose your own
14.3 Writing process
14.3.1 Writing the Report
14.3.2 The tripartite structure of a formal report
14.3.3 Explanation of
Tripartite Structure
14.3.4 A note on page numbering
14.4 Citing your sources
14.5 Oral Reports
14.6 What to turn in
15. Poster presentation
15.1 Goals--informal poster presentation, library work
15.2 Textbook resources
15.3 Audience Assessment--fellow students
15.4 Preliminary Draft
15.4.1 Choosing the graphic elements
15.4.2 Preparing the poster
15.5 Final draft
Bibliography
A. Grammar and format notes (read this appendix first)
A.1 Content errors
A.2 Discourse structure errors
A.2.1 Sections and section headers
A.2.2 Paragraphs
A.2.3 Pronouns
A.2.4 Tone
A.3 Format errors
A.4 Sentence structure errors
A.4.1 Faults in style
A.4.2 Faults in grammar
A.5 Punctuation errors
A.5.1 Hyphens and dashes
A.5.2 Quotation marks
A.5.3 Parentheses and brackets
A.5.4 Commas and related marks
A.6 Word choice errors
A.6.1 Commonly misused words and phrases
A.6.2 Sentence grammar affects word choice
Kevin Karplus
Computer Engineering
University of California, Santa Cruz
Santa Cruz, CA 95064
USA
karplus@soe.ucsc.edu
1-831-459-4250
HTML version created 2003-02-13
