 | |||
 | |||
|
CS 312 Software User Documentation
Fall 2006
|
        | ||
|
Course Description PREREQUISITE: CS 310 and EH 102. Introduction to writing and evaluating software documentation. Emphasis on writing, analyzing, and evaluating documentation. Course Objectives
Required Text and Course Materials Writing Software Documentation: A Task-Oriented Approach. 2nd EDITION. Barker – Allyn & Bacon. 2003. (ISBN: 0-321-10328-9) one 3 1/2" floppy disk Tentative Course Outline Chapter 1 Understanding Task Orientation Chapter 5 Analyzing Your Users Chapter 6 Planning and Writing Your Documents Manual Constructing a Task List EXAM 1 20% of your course grade Manual Work will proceed on the actual user manual Chapter 10 Designing for Task Orientation Chapter 11 Laying Out Pages and Screens Chapter 12 Getting the Language Right EXAM 2 20% of your course grade Manual Work will proceed on the actual user manual Chapter 13 Using Graphics Effectively Chapter 14 Designing Indexes Chapter 9 Editing and Fine Tuning EXAM 3 20% of your course grade Manual The manual will be completed before finals begin Lectures Writing Proposals FINAL EXAM 20% of your course grade - FINAL IS NOT COMPREHENSIVE NOTE: The remaining 20% of your course grade will come from writing an actual “real-world” user manual. Every student WILL write a portion of the manual.
Attendance While attendance is not mandatory, you should make every effort to attend all classes. Roll WILL be taken. If you come into class tardy - after attendance has been taken - be sure to tell me after class that you were late so I can count you present. (Please do not make a habit of coming to class tardy.) In order to perform well in the class, attendance needs to be a priority. YOU are responsible for all material missed, including announcements and assignments made in class, on days you are absent. It is your responsibility to obtain notes from a fellow student when you are absent. Office hours are not meant for individual lectures. Absence, no matter the reason, does NOT excuse being unprepared for exams, assignments, etc., etc. I have little sympathy for those students who have problems when they do not come to class regularly. Please prepare yourself to remain in the classroom during the entire class meeting. Students who constantly get up and wander in and out of the room during class are disruptive to the other students. If you do need to leave the room, please do so quietly. All students are expected to attend class fully prepared with appropriate materials and all devices which make noise turned to the off position (e.g., cellular phones, pagers, personal stereos, etc.). Students are NOT to conduct business (personal or otherwise) during class time. Taking phone calls during class time is disruptive to the other students in the class. Any student behavior deemed disruptive by the professor will result in expulsion of the student from the classroom, with an absence for the day and possible disciplinary action. Homework You will receive homework assignments during the semester which are to be completed outside of class time. Late homework assignments will NOT be accepted - no matter the reason. We will complete an actual user manual during the semester and will have a deadline. We cannot afford to and will not accept any late assignments if we are to meet the deadline. If you find you must be absent on the day an assignment is due, send your assignment with another student, put it in my mailbox, or bring it to me BEFORE it is due. REMEMBER: Late homework assignments will NOT be accepted - no matter the reason. Exams Alternate exam schedules will be arranged only when the absence from the exam is cleared with me WELL IN ADVANCE. The only acceptable excuse for missing an exam (without prior approval) is illness; however, other excuses will be considered. Being unprepared for an exam is NOT an acceptable excuse. When an exam is missed because of illness, a doctor's excuse must be provided in order to make up the exam (no photocopies of doctor's excuses will be accepted). Only one (1) major exam can be made up per semester. It really is to your advantage to take all exams on time. Course Performance/Grades Grades are not "given," they are earned. I am more than happy to meet with any student to discuss their course performance or grades. If you ever have any questions or concerns about a grade you earn on an exam or homework, please feel free to consult with me. Plagiarism Copying WILL NOT be tolerated. Each student is expected to do his/her own outside assignments and to ensure that NO ONE uses his/her work. Getting "help" from another student (including lab workers) IS plagiarism. The penalty for plagiarism is a grade of zero for ALL students involved. University Policies All current JSU policies will apply. You are responsible for being aware of and abiding by these policies, including the Academic Honesty Policy in the current Student Handbook.
|
|||
 |
|
|
|
©
2003, Karen Myers.